v1
latestSwagger 2.02026-07-14171634.2 KBRequest 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.
Query parameters
URL of the page to get a screenshot for
instance ID to use
screenshot size - "screen" (default) or "page"
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.
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.
number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.
width of the browser window. For desktop browsers only.
height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)
assign priority to the screenshot (for private instances only)
use a custom referrer header - paid screenshots only
send a POST requests with post_data, useful for filling out forms - paid screenshots only
set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only
URL of javascript file to execute after the page load event
level of information available with screenshot/info
saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs 1 credit per screenshot.
maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)
any custom HTTP headers. (Not supported with Internet Explorer)
take multiple screenshots of the same page. This costs 1 additional credit for every 2 additional screenshots.
number of seconds between 2 screenshots
hosting option - s3 or browshot
maximum height of the thumbnail to host
maximum height of the thumbnail to host
scale of the thumbnail to host
S3 bucket to upload the screenshot or thumbnail (required for S3)
file name to use (for S3 only)
list of headers to add to the S3 object (for S3 only)
Response
Request accepted