Choose the right screenshot workflow.

Pattern 1 - Single page, real-time web screenshot

Pattern 1 involves taking a single real-time screenshot of a webpage in response to a single-page request using an API key, without the need for background processing or queuing, and with support for synchronous or asynchronous connections.

The high-level screenshot architecture is shown below.

1. Make an HTTP GET or POST request containing the URL, your API key, and optional configuration options such as storage or request templates.
2. The Screenshot API visits the website URL and captures a screenshot.
3. The screenshot image is returned in a format such as PNG, JPEG, or JSON (base64 encoded).

Example request to take a screenshot with the Screenshot API using the default options:

// Line breaks added for readabilityGET https://api.addscreenshots.com/screenshots?apikey=YOUR_API_KEY
    &url=https://www.youtube.com

Your API key can be found on the API Keys page. Need an API Key? Sign up to get started.
For internal applications, replace YOUR_API_KEY with your own unique API Key.
For public facing websites or hotlinks, generate a signed URL.

Pattern 2 - Cached Website Screenshots

The cached website screenshot pattern is similar to pattern 1, but the screenshot is cached based on a specified time-to-live duration. This pattern is ideal for public websites with multiple users who require the same screenshot without re-capturing every time.

Refer to the screenshot caching page for more information.

1. Make an HTTP GET request containing the URL, your API key, and the cache duration in seconds.
2. The Screenshot API checks for a cached version of the screenshot in Cloudflare's Content Delivery Network (CDN).
3. A screenshot is taken if the image does not exist in the cache or if the cache has expired; otherwise, the cached image is returned to the user.
4. If a new screenshot is created, it is added to the cache based on the specified duration in seconds.
5. The screenshot image is returned to the user.

Pattern 3 - Single Page Screenshot with Website Interaction

A screenshot request can include information such as automation steps to interact with the website (e.g., login or search for a flight) before capturing a screenshot. See the website screenshot automation page for more information and request examples.

1. Make an HTTP POST request containing the URL, your API key, and automation steps to interact with the website.
2. The Screenshot API will interact with the website (e.g., filling in forms and clicking on buttons) and capture a screenshot.
3. The screenshot image is returned in a format such as PNG, JPEG, or JSON (base64 encoded).

Background screenshots allow you to take large volumes of screenshots in bulk using a single request that can contain multiple web pages, a sitemap, or a domain name. The screenshot images will be uploaded to a cloud storage drive that you manage, such as an AWS S3 Bucket or Azure Blob Storage Account.

A background request must:

• Use the POST method.
• Supply storage account details or a storage account template to store screenshots.

Unlike real-time screenshots, which require the user to wait for completion, background requests work in a "fire-and-forget" manner, returning a success response immediately while the bulk website screenshots are processed in the background.

Monitor your cloud storage account for screenshot images to show up. The background worker pool processes screenshots, allowing you to capture more than a thousand websites per minute (depending on page load speed, required interaction, and website load handling).

1. Submit an HTTP POST request with the URL (multiple pages, sitemap, or domain), your API key, and any optional browser, image, and automation settings.
2. The Screenshot API will queue the request, allowing background processing without requiring the client to wait for completion.
3. A JSON confirmation will be returned, detailing the number of screenshots to be taken.
4. An auto-scaling pool of workers will handle the screenshot requests.
5. The screenshot worker will visit the specified website and capture the screenshot, storing it in memory (not on disk).
6. The screenshot worker will then save (or email) the screenshot to your cloud storage (e.g., AWS S3, Azure Blobs, etc.).

Pattern 4 - Multi-Page Website Screenshots

Use this pattern to take screenshots of multiple pages from a single domain. It can be combined with storage account templates to save the screenshots to a cloud storage account.

Need a step-by-step playbook? Explore the dedicated Bulk Website Screenshot Pattern for advanced automation, storage templates, and API examples.

The following example demonstrates how to capture multiple page screenshots with a single POST request. The screenshot images will be uploaded to an Azure Blob store using a Shared Access Token. The screenshots will be organized in the "{domain}" folder (pattern) and named according to the "{filepath}" pattern (pattern).

POST https://api.addscreenshots.com/screenshots/bulk/multi?apikey=YOUR_API_KEY

{
  "urls": [
    "google.com",
    "youtube.com",
    "apple.com"
  ],
  "azure": "https://screenshots.blob.core.windows.net/screenshotdemo?st=2020-08-10T07%...fEWvNz6fbdeUenY%3D",
  "file": "{filepath}",
  "folder": "{domain}"
}

The API response will include the number of screenshots as shown below:

{
  "message": "The screenshots are being processed.",
  "jobId": "536b69dbefa240d493330ae5de1c0d46",
  "screenshots": 3
}

Take multiple screenshots by overriding various properties per screenshot, such as the file name, as shown below.

POST https://api.addscreenshots.com/screenshots/bulk/multi?apikey=YOUR_API_KEY

{
  "urls": [
    {
      "url": "google.com",
      "file": "hey-google"
    },
    {
      "url": "apple.com",
      "file": "hello-apple",
      "fullpage": true
    },
    {
      "url": "youtube.com"
    }
  ],
  "azure": "https://screenshots.blob.core.windows.net/screenshotdemo?st=2020-08-10T07%...fEWvNz6fbdeUenY%3D",
  "file": "{filepath}",
  "folder": "{domain}",
  "fullpage": false
}

Note that a full-page screenshot will be taken of apple.com since the default full-page property was overridden for that URL.

Pattern 5 - Sitemaps and URL List Screenshots

Specify a sitemap.xml file to capture all of the URLs contained in the sitemap. For example, https://www.addscreenshots.com/sitemap.xml

You can also specify a text file (e.g., websites.txt) that contains a list of website URLs to take screenshots of. Note that each website URL must start on a new line.

The response will include the number of URLs read from the sitemap and website list. If the request times out, verify that the sitemap or list is hosted on a fast server or that the list is not too large (e.g., > 5000 websites), which may cause a read timeout.

The example below shows how to take screenshots using multiple sitemaps in a single POST request. The screenshot images will be uploaded to an Azure Blob store using a Shared Access Token. The screenshots will be stored in the folder "{domain}" (pattern) with the filename "{filepath}" (pattern).

POST https://api.addscreenshots.com/screenshots/bulk/sitemap?apikey=YOUR_API_KEY

{
  "urls": [
    "https://www.apple.com/sitemap.xml",
    "https://www.cloudflare.com/sitemap.xml"
  ],
  "azure": "https://screenshots.blob.core.windows.net/screenshotdemo?st=2020-08-10T07%...fEWvNz6fbdeUenY%3D",
  "file": "{filepath}",
  "folder": "{domain}"
}

The API response will include the number of screenshots as shown below:

{
  "message": "The sitemap screenshots are being processed.",
  "jobId": "7b07194f706e47a7af868bb9b2ff12d7",
  "screenshots": 1366
}

Pattern 6 - Capture Screenshots of an Entire Domain

Scrape and crawl an entire domain to take screenshots. This approach works well for small, fast websites that can be processed within a couple of minutes.

Use a sitemap or list for websites with many pages.

The example below shows how to take screenshots of an entire domain using a single POST request. The screenshot images will be uploaded to an Azure Blob store using a Shared Access Token. The screenshots will be stored in the folder "apple" using the filename "{filepath}" (pattern).

POST https://api.addscreenshots.com/screenshots/bulk/domain?apikey=YOUR_API_KEY

{
  "url": "https://www.apple.com",
  "azure": "https://screenshots.blob.core.windows.net/screenshotdemo?st=2020-08-10T07%...fEWvNz6fbdeUenY%3D",
  "file": "{filepath}",
  "folder": "apple"
}

The API response will include the number of screenshots as shown below:

{
  "message": "The domain screenshots are being processed.",
  "jobId": "233b69dbefa240d493330ae5de1c0d38"
}

The domain request above took less than a minute to process, capture, and upload over 1,000 screenshots.

Pattern 7 - Take Website Screenshots at Scheduled Intervals

Use scheduling to capture screenshots at regular intervals such as weekly, daily, hourly, or based on a custom interval (using a CRON notation).

Scheduling is shown below:

1. Set up a schedule that will enqueue the request
2. The worker pool will process the scheduled request
3. Capture the website screenshot
4. Upload the screenshot to a cloud storage account based on a customizable file and folder naming convention

Only WRITE access to the cloud storage account is required for this pattern.

Scheduling is built into Add Screenshots — define a schedule and recurring captures run automatically, with partner infrastructure from Cloudy Scheduler helping power it behind the scenes.

Pattern 8 - Track Website Changes with Email Notification

To extend the scheduling pattern, it is also possible to compare the current screenshot with the previous screenshot to determine if a notable change (based on a configurable % difference) was detected.

Track changes can save a copy of the old screenshot, save the new screenshot, and save a diff image to highlight what has changed.

You can also configure an email notification to alert clients when a change is detected. For example, notify me when my competitor updates the pricing page on their website.

READ and WRITE access to the cloud storage account is required for this pattern.