Making requests | Documentation | Screenshot API | WhoisXML API

Making requests

GET https://website-screenshot.whoisxmlapi.com/api/v1?apiKey=YOUR_API_KEY&url=google.com
It takes up to a minute to activate your account after the registration.

Input parameters

apiKey

Required. Get your personal API KEY on My products page.

url

Required. The target website's url.

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

imageOutputFormat

Optional. Response output format.

Acceptable values: image | base64

Default: image

errorsOutputFormat

Optional. Errors output format.

Acceptable values: JSON | XML

Default: JSON

type

Optional. Image output type.

Acceptable values: jpg | png pdf

Default: jpg

quality

Optional. Image quality. (only for jpg type).

Acceptable values: 40 < quality < 99

Default: jpg

width

Optional. Image width (px).

Acceptable values: 100 < width < 3000

Default: 800

height

Optional. Image height (px).

Acceptable values: 100 < width < 3000

Default: 600

thumbWidth

Optional. Image thumb width (px).

Acceptable values: 50 < thumbWidth < width param value

Default: 0

mode

Optional.

fast - waiting for the document.load event.

slow - waiting for network idle event.

Acceptable values: fast | slow

Default: fast

scroll

Optional. If specified (any value), scrolls down and up (useful for fullpage screenshots).

fullPage

Optional. If specified (any value), makes full-page screenshot.

noJs

Optional. If specified (any value), disables JS.

delay

Optional. Custom delay (ms) before screen capture.

Acceptable values: 0 < delay < 10000 ms

Default: 250

timeout

Optional. Custom timeout (ms) for page loading.

Acceptable values: 1000 < timeout < 30000 ms

Default: 15000

scale

Optional. deviceScaleFactor value for the emulator.

Acceptable values: 0.5 < scale < 4.0

Default: 1.0

retina

Optional. If specified (any value), emulates retina display.

ua

Optional. The 'User-Agent' header string.

mobile

Optional. If specified (any value), emulates mobile device.

touchScreen

Optional. If specified (any value), emulates device with a touch screens.

landscape

Optional. If specified (any value), 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.

Usage limits and requests throttling

The maximum number of requests per minute is 120. In case that the limit is breached, your subsequent requests will be rejected until the next minute.

Have questions?

We are here to listen. For a quick response, please select your request type or check our Contact us page for more information. By submitting a request, you agree to our Terms of Service and Privacy Policy.

Or shoot us an email to