The simplest possible API request.

    
    
    
POST: http://screend.it/api/screenshot/?api_token=XXXXXXXXXXXX { url: "https://target-site.com", file: "/screenshots/image.png" }

All the available options.

    
    
    
{ url: "https://target-site.com", file: "/screenshots/image.png", viewport: "1366x768", crop: "1366x768", thumbnail: "100x100", hide_lightboxes: 1 }

Parameters

url

The target site that you want a screenshot of.

Examples: "http://target-site.com", "https://target-site.com"

file

The file path you want your screenshot saved on your S3 bucket. The output file format will be determined by the file extension you specify here.

Examples: "image.jpg", "image.png", "images/images.png"

viewport

The dimensions of the browser screen to render the screenshot.

Ex: 1366x768

crop

The dimensions of the output file.

Ex: 800x600

thumbnail

Dimensions to resize the output file to. (Will maintain aspect ratio)

Ex: 100x100

hide_lightboxes

Automatically removes modals, popups, or lightboxes from screenshots.

Ex: "true", "false"