v1

latestSwagger 2.02026-07-14171634.2 KB
Screenshot

Request a screenshot

Screenshots requests to private and shared instances require a positive balance.

IMPORTANT: Remember that you can only do 100 free screenshots per month. To used a premium instance, use instance_id=65 for example.

get/screenshot/create

Query parameters

urlstring required

URL of the page to get a screenshot for

instance_idinteger required

instance ID to use

size'screen' | 'page'

screenshot size - "screen" (default) or "page"

cacheinteger

use a previous screenshot (same URL, same instance) if it was done within <cache_value> seconds. The default value is 24hours. Specify cache=0 if you want a new screenshot.

delayinteger

number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0 to take screenshots faster.

flash_delayinteger

number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.

screen_widthinteger

width of the browser window. For desktop browsers only.

screen_heightinteger

height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)

priorityinteger

assign priority to the screenshot (for private instances only)

refererstring

use a custom referrer header - paid screenshots only

post_datastring

send a POST requests with post_data, useful for filling out forms - paid screenshots only

cookiestring

set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only

scriptstring

URL of javascript file to execute after the page load event

detailsinteger

level of information available with screenshot/info

htmlinteger

saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs 1 credit per screenshot.

max_waitinteger

maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)

headersstring

any custom HTTP headers. (Not supported with Internet Explorer)

shotsinteger

take multiple screenshots of the same page. This costs 1 additional credit for every 2 additional screenshots.

shot_intervalinteger

number of seconds between 2 screenshots

hosting's3' | 'browshot'

hosting option - s3 or browshot

hosting_heightinteger

maximum height of the thumbnail to host

hosting_widthinteger

maximum height of the thumbnail to host

hosting_scalenumber float

scale of the thumbnail to host

hosting_bucketstring

S3 bucket to upload the screenshot or thumbnail (required for S3)

hosting_filestring

file name to use (for S3 only)

hosting_headersstring

list of headers to add to the S3 object (for S3 only)

Response

Request accepted

cookiestring

custom cookie used (see Custom POST Data, Referer and Cookie)

costinteger

number of credits spent for the screenshot

delayinteger

number of seconds to wait after page load

detailsinteger

level of details about the screenshot and the page

errorstring

description of the problem that occurred

final_urlstring

URL of the screenshot (redirections can occur)

flash_delayinteger

number of seconds to wait after page load if Flash elements are present

heightinteger

screenshot height

idinteger required

screenshot ID

instance_idinteger required

instance ID used for the screenshot

post_datastring

POST data sent (see Custom POST Data, Referer and Cookie)

priorityinteger

priority given to the screenshot: high (1) to low (3)

refererstring

custom referrer used (see Custom POST Data, Referer and Cookie)

scalenumber double

image scale. Always 1 for desktop browsers; mobiles may change the scale (zoom in or zoom out) to fit the page on the screen

{"stackTrail":"components:schemas:Screenshot:properties:screenshot_url","oasType":"schema","type":"unknown","description":"URL to download the screenshot"}
scriptstring

URL of optional javascript file executed after the page load event

shared_urlstring

if the screenshot was shared, show the public URL

size'screen' | 'page'

screenshot size requested

status'in_queue' | 'processing' | 'finished' | 'error' required

status of the request: "in_queue", "processing", "finished", "error"

urlstring required

original URL requested

widthinteger

screenshot width