Screenshots

Screenshots are the core resource on Screenshots.so.

You capture screenshots by sending a GET or POST request with the website's url and a list of customizable parameters. These parameters can help you capture screenshots on different dimensions, select custom element via CSS selectors, grab fullscreen screenshots, etc.

Screenshots.so responds in two forms:

  1. The raw JPG or PNG image
  2. A JSON object that includes a public link to the generated screenshot.

Parameters

Visit the parameters page to view all the available parameters.

GET /v1

The most simple way to grab screenshot and customize it by appending query parameters to the base URL.

JavaScript Example

fetch(
    method: "GET",
    "https://api.screenshots.so/v1?url=https://www.brandbird.app&device=desktop&disableCache", 
    {
        headers: {
            "Authorization": "Bearer API_KEY",
        },
    }
)

Sample JSON Response

{
    "imageURL": "https://storage.googleapis.com/brandbird/screenshots/9b2d62e1-9e85-4a3c-adf9-75fc693f33c2.jpeg"
}

POST /v1

Choose the POST method when you want to pass many parameters via the request's body and want a cleaner method than query parameters.

💡

Remember to pass the "Content-Type": "application/json" header

JavaScript Example

fetch(
    "https://api.screenshots.so/v1?url=https://www.brandbird.app&device=desktop&disableCache", 
    {
        method: "POST",
        headers: {
            "Authorization": "Bearer API_KEY",
            "Content-Type": "application/json"
        },
        body: {
            "url": "https://www.brandbird.app",
            "quality": 70,
            "isBinary": false,
            "device": "Macbook Pro 14",
            ...
        }
    }
)

Sample JSON Response

{
    "imageURL": "https://storage.googleapis.com/brandbird/screenshots/9b2d62e1-9e85-4a3c-adf9-75fc693f33c2.jpeg"
}