Screenshot Options

Test all available options in our interactive Screenshot API Playground

url

A webpage URL is required, this is the URL of which you want to take a screenshot.

If the URL contains any query parameters the URL will require to be encoded. We have some code examples on how to encode URL for multiple programming languages.

force

Force option tells API to render a new screenshot even if the request can be fulfilled by a recently created screenshot, by default API will try and reuse an existing screenshot based on your options.

Valid options are

• false ( this is default)
• true

format

format is the final screenshot image format that you want API to generate. You can use anyone the following image formats

• png ( this is default )
• webp
• avif
• jpg or jpeg

TIP:

We provide free format conversion even after rendering the screenshot, you can convert any screenshot into any format even after rendering. You can find links to all format files in the dashboard for each screenshot you created.

viewport

Viewport is browser viewport you want to set for the screenshot, viewport can be set like this 1367x768 (widthxheight) the width and heights are in pixels.

• 1366x1366 ( this is default for generating square images 80% free tier users want square images)

Other examples ( you can set it any value you find fit )

• 1400x900
• 800x600
• 1920x1080

resize

Set resize option to resize the screenshot, after generating it, in a specific width and height you can set like this 400x400 (widthxheight). The width and heights are in pixels.

Sample options

• 400x500
• 600x600
• 350x350

full_page

full_page option tells API to render webpage to its full height. We load URL and wait a little, then take screenshot, the screenshot generated with this option is really big in size and can take a lot of time.

Valid options are

• false ( this is default)
• true

dark_mode

dark_mode option tells API to set default browser mode to dark before taking a screenshot.

Valid options are

• false ( this is default)
• true

wait_before_screenshot

wait_before_screenshot option tells API to wait for the set amount of milliseconds before taking a screenshot. This is helpful in cases where some images on the webpage takes time to load.

Sample options

• 0 ( this is default)
• 2000 ( 2 seconds)
• 5000 (5 seconds)

device_scale_factor

device_scale_factor set this option to create a high quality ( retina ) screenshot by setting a higher pixel density, this option creates images which are very big in size and resolution.

Sample options

• 1 ( this is default)
• 2 ( Retinal display quality)

timeout

timeout option is the hard limit for a screenshot process to finish. The screenshot will fail if the timeout is reached and the screenshot is not created. Timeout can be set in milliseconds , timeout is counted as soon as the API start processing the screenshot request.

Sample options

• 60000 ( 60 seconds this is default)
• 30000
• 50000

_{Free plan users can set a maximum of 90000 (90 seconds)}

proxy

Proxy option lets you set your own proxy URL. Screenshot will be rendered using proxy server as provided by you. Our API accepts proxy URL with and without authentication

Sample proxy URL

• 192.168.1.1:3128
• username:password@192.168.1.1:3128
• some-proxy-provider.com:3128
• username:password@some-proxy-provider.com:3128

hide_banners

hide_banners option tells API to click/hide all cookie consent banners before taking a screenshot.

Valid options are

• true ( this is default)
• false