API docs

Making requests

GEThttps://website-screenshot-api.whoisxmlapi.com/api/v1?apiKey=YOUR_API_KEY&url=google.com

It takes up to 2 minutes to activate your account after Sign Up.

Input parameters: required

apiKey
Get your personal API KEY on My products page.
url
The target website's url.

Note that if the URL contains some "special characters", f.e. '&, ?, #, =', you should encode the URL.

Input parameters: optional

imageOutputFormat
Response output format.

Acceptable values: image | base64

Default: image
errorsOutputFormat
Errors output format.

Acceptable values: JSON | XML

Default: JSON
type
Image output type.

Acceptable values: jpg | png | pdf

Default: jpg
quality
Image quality. (only for jpg type)

Acceptable values: 40 < quality <99

Default: 80
width
Image width (px).

Acceptable values: 100 < width < 3000

Default: 800
height
Image height (px).

Acceptable values: 100 < height < 3000

Default: 600
thumbWidth
Image thumb width (px).

Acceptable values: 50 < thumbWidth < width param value

Default: 0
mode
fast - waiting for the document.load event.

slow - waiting for network idle event.

Acceptable values: fast | slow

Default: fast
scroll
If specified, scrolls down and up (useful for fullpage screenshots).
fullPage
If specified, makes full-page screenshot.
noJs
If specified, disables JS.
delay
Custom delay (ms) before screen capture.

Acceptable values: 0 < delay < 10000 ms

Default: 250
timeout
Custom timeout (ms) for page loading.

Acceptable values: 1000 < timeout < 30000 ms

Default: 15000
scale
deviceScaleFactor value for the emulator.

Acceptable values: 0.5 < scale < 4.0

Default: 1.0
retina
If specified, emulates retina display.
ua
The 'User-Agent' header string.
mobile
If specified, emulates mobile device.
touchScreen
If specified, emulates device with a touch screens.
landscape
If specified, renders page in landscape mode (useful for smartphone emulation).

Free access

After Sign Up you automatically get a free subscription plan limited to 500 queries per month.

Sample output

BlackBerry Q10 (720 x 720)

  • Width: 360, Height: 360
  • Scale: 2.0
  • Mobile: true
  • Delay: 1500
  • User-Agent: BlackBerryQ10/10.1.0.4459 Profile/MIDP-2.1 Configuration/CLDC-1.1 VendorID/537.10+

HTC One (1080 x 1920)

  • Width: 360, Height: 640
  • Scale: 3.0
  • Mobile: true
  • Delay: 1500
  • User-Agent: Mozilla/5.0 (Linux; Android 6.0; HTC One M9 Build/MRA58K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.98 Mobile Safari/537.36

iPad Pro (2048 x 2732)

  • Width: 1024, Height: 1366
  • Scale: 2.0
  • Delay: 1500
  • User-Agent: Mozilla/5.0 (iPad; CPU OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1

Desktop Full HD (1920 x 1080)

  • Width: 1920, Height: 1080
  • Scale: 1.0
  • Delay: 1500
  • User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36

Account balance information

GEThttps://user.whoisxmlapi.com/service/account-balance?apiKey=YOUR_API_KEY
apiKey
Required. Get your personal API KEY on My products page.
productId
Optional. A list of the products' IDs can be found in the response.

- You can always check your account balance on the My products page. - Note that the following products use the same WHOIS credits: WHOIS API, Bulk WHOIS API, Domain Availability API. - Note that the following products use the same Domain Research Suite credits: Brand Alert API, Registrant Alert API, Reverse WHOIS API, WHOIS History API.

List of possible errors

403 Forbidden
Access restricted. Check credits balance or enter the correct API key.
409 Conflict
Requested URL is unreachable.
422 Unprocessable Entity
Input correct URL.
429 Too Many Requests
Too Many Requests. Try your call again later.
5XX
Internal server error. Try your call again or contact us.
Try our Screenshot API for free
Get started
Have questions?
support@whoisxmlapi.com
We will get back to you within a day.
WHOIS API, Inc.

California
USA

Contact us