Options
Essentials
access_key
Each request must have an access key to authenticate the API user.
url
URL of the site to take a screenshot of.
signature
A signature is optional. It is used for the singed requests.
format
Available response formats:
png
jpeg
webp
jpg
full_page
Take the screenshot of the full page.
Viewport
viewport_width
The width of the browser viewport (pixels).
viewport_height
The height of the browser viewport (pixels).
device_scale_factor
Set the device scale factor. Acceptable value is one of:
- 1
- 2
- 3
Image
image_quality
Render image with specified quality. Available for the next formats:
jpeg
(jpg
)webp
omit_background
Render a transparent background for the image. Works only if the site has not defined background color. Available for the following response formats:
png
webp
Blocking
block_ads
Block ads.
block_trackers
Block trackers.
block_requests
Block requests by specifying URL, domain, or even a simple pattern.
block_resources
Blocks loading resources by type. Available resource types are:
document
stylesheet
image
media
font
script
texttrack
xhr
fetch
eventsource
websocket
manifest
othe
Geolocation
geolocation_latitude
Set geolocation latitude for the request. Both latitude and longitude are required if one of them is set.
geolocation_longitude
Set geolocation longitude for the request. Both latitude and longitude are required if one of them is set.
geolocation_accuracy
Set the geolocation accuracy in meters.
Request
user_agent
A user agent for the request.
authorization
Set the Authorization
header for the request.
headers
Set extra headers for the request.
cookies
Set cookies for the request.
time_zone
Sets time zone for the request. Available time zones are:
America/Santiago
Asia/Shanghai
Europe/Berlin
America/Guayaquil
Europe/Madrid
Pacific/Majuro
Asia/Kuala_Lumpur
Pacific/Auckland
Europe/Lisbon
Europe/Kiev
Asia/Tashkent
Europe/London