access_token (required) | | A valid API access token is required to make requests. You can manage your access tokens in the admin panel. |
url (required) | | The complete URL including protocol of the web page you want to capture. |
mode | fullpage | Choose the capture mode. Either fullpage, viewport or element |
height | 1080 | The height in pixels of the viewport to capture. This is ignored if mode parameter is set to full_page. |
width | 1920 | The width in pixels of the viewport to capture. |
response_type | image | Choose a response type. image will return an image type response which you can save directly. json will provide a json response with HTTP status code and a hosted image link. This image should be saved immediately as images are deleted after a pre-determined time period. (Usually 30 days).
A json type responsed will contain image, url and remote_status. Image is the URL of the hosted screenshot. URL is the URL of the captured page. Remote_status is the HTTP response code received from the target URL. |
format | jpeg | The format of the image captured. Chose either jpeg or png. |
delay | 0 | The delay in seconds (after page load) to wait before capturing a screenshot. Choose from 0 to 10 seconds (maximum). |
file_name | | You can provide a filename which will be used when storing the screenshot. |
user_agent | | Set a User Agent header to be used when capturing a screenshot, to emulate a device or browser type. Ensure the User Agent string is URL encoded to be used correctly. You can find a list of user agents sorted by device/software/layout engine here. |
block_ads | false | Blocks common advertising networks to prevent ads from being captured in screenshots. Set this to true or false. |
accept_lang | | Set the Accept Language header on requests to the target page to capture screenshots in the specified language. More information is available here. |
grayscale | false | Apply a grayscale filter to the captured screenshot. |
js | | Javascript string to be injected onto the target page. The string must be URL encoded to be properly parsed and injected. |
css | | CSS styling string to be injected onto the target page. The string must be URL encoded to be properly parsed and injected. |