Parameters
These request parameters will help you customize the screenshot appearance & functinality.
url
The URL from the website that you want to screenshot. (Required)
Type: string
Default: null
device
The device parameter defines the screenshot dimensions. Check the complete list of available devices.
Type: string
Default: desktop
width and height
Loads the website to these dimensions and then captures the screenshots. Always define both the width & height parameter or none of them.
Type: number
Default: null
fullPage
When true, takes a screenshot of the full scrollable page.
Type: boolean
Default: false
type
If true, the request return the screenshot as a binary JPEG image. Binary responses are never cached.
Type: 'jpeg' or png
Default: jpeg
isBinary
When true, the request returns the screenshot as a binary JPEG image. Otherwise, it returns an JSON object with the screenshots's publi url imageURL.
Binary responses are never cached.
Type: boolean
Default: false
waitUntil
When to consider navigation succeeded, defaults to load. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
load: consider navigation to be finished when the load event is fired.domcontentloaded: consider navigation to be finished when the DOMContentLoaded event is fired.networkidle0: consider navigation to be finished when there are no more than 0 network connections for at least 500 ms.networkidle2: consider navigation to be finished when there are no more than 2 network connections for at least 500 ms.
Type: load or domcontentloaded or networkidle0 or networkidle2
Default: networkidle0
quality
The quality of the image, between 0-100. Not applicable to png images.
Type: number
Default: 70
disableCache
When true, disables cache and returns a fresh screenshot
Type: boolean
Default: false
acceptCookieBanners
When true, automatically accepts cookie banners.
Type: boolean
Default: true
disableLazyLoading
When true, disables lazy loading to take fullpage screenshot with fully loaded images.
Type: boolean
Default: true
selector
Takes a screenshot of the CSS selector passed.
If the selector doesn't exist, the request will timeout.
Type: string
Default: null
scrollToElement
Scroll to the element with the scrollToElement CSS selector.
If the scrollToElement selector doesn't exist, there will be no scroll.
Type: string
Default: null
delay
Wait for delay ms before taking the screenshot.
Type: number
Default: 0