# Delete Task
Source: https://docs.screenshotmax.com/endpoints/delete-tasks

DELETE https://api.screenshotmax.com/v1/tasks/{id}
Delete a scheduled task

It’s simple to use: you only need to submit your `access_key` and the task `id`. The API will delete the scheduled task for your account.

<Warning>
  **Plan Requirement**

  Scheduled Tasks are available only on the **Scale plan**.
  Upgrade your account via the Subscription / Dashboard [section](https://app.screenshotmax.com/subscribe/monthly) to unlock this feature.
</Warning>

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Task API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST and PATCH requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/tasks
```

### Validation endpoint

ScreenshotMAX’s Task API simply requires your unique access key. The API will return an empty response.

```
DELETE https://api.screenshotmax.com/v1/tasks/5650820808835072
? access_key=YOUR_ACCESS_KEY
```

This was a successful request, so the API returned a 204 Created response.

### Path parameters

<ParamField path="id" type="string" required>
  Unique identifier for the scheduled task.
</ParamField>

### Query parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

### Response parameters

The API will return a 204 No Content response if the task was successfully deleted. There is no response body.

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                          |
| ---- | --------------------- | ---------------------------------------------------------------- |
| 204  | OK                    | The request was successful.                                      |
| 400  | Bad Request           | The request was rejected due to a missing or invalid parameter.  |
| 401  | Unauthorized          | The request was rejected due to an invalid access key.           |
| 402  | Payment Required      | Access denied due to an unpaid invoice.                          |
| 404  | Not Found             | The requested resource was not found.                            |
| 423  | Locked                | The request was denied due to insufficient quota.                |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute). |
| 500  | Internal server error | The request failed due to an internal server error.              |


# Devices
Source: https://docs.screenshotmax.com/endpoints/devices

GET https://api.screenshotmax.com/v1/devices
Get a list of available devices for emulation.

It’s simple to use: you only need to submit your `access_key`. The API will return a list of available devices for emulation.

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Device API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Device API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Device API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/devices
```

### Validation endpoint

ScreenshotMAX’s Device API simply requires your unique access key. The API will return a list of available devices for emulation.

```
https://api.screenshotmax.com/v1/devices
? access_key=YOUR_ACCESS_KEY
```

This was a successful request, so the API returned a 200 OK response with the list of available devices for emulation.

```json
{
    "devices": [
        {
            "id": "blackberry_playbook",
            "name": "Blackberry PlayBook",
            "viewport": {
                "width": 600,
                "height": 1024,
                "device_scale_factor": 1,
                "mobile": true,
                "landscape": false,
                "has_touch": true
            }
        },
        {
            "id": "blackberry_playbook_landscape",
            "name": "Blackberry PlayBook landscape",
            "viewport": {
                "width": 1024,
                "height": 600,
                "device_scale_factor": 1,
                "mobile": true,
                "landscape": true,
                "has_touch": true
            }
        },
        ...
    ]
}
```

### Request parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

### Response parameters

The API response is returned in a universal and lightweight [JSON format](https://www.json.org/json-en.html).

<ResponseField name="devices" type="object[]">
  List of available devices for emulation.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Device ID. Name of the device in snake\_case format.
    </ResponseField>

    <ResponseField name="name" type="string">
      Device name.
    </ResponseField>

    <ResponseField name="user_agent" type="string">
      Device user agent.
    </ResponseField>

    <ResponseField name="viewport" type="object">
      Device viewport.

      <Expandable title="properties">
        <ResponseField name="width" type="number">
          Viewport width.
        </ResponseField>

        <ResponseField name="height" type="number">
          Viewport height.
        </ResponseField>

        <ResponseField name="device_scale_factor" type="number">
          Device scale factor.
        </ResponseField>

        <ResponseField name="mobile" type="boolean">
          Whether the `meta viewport` tag is taken into account.
        </ResponseField>

        <ResponseField name="landscape" type="boolean">
          Specifies if the viewport is in landscape mode.
        </ResponseField>

        <ResponseField name="has_touch" type="boolean">
          Specify if the viewport supports touch events.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                |
| ---- | --------------------- | ------------------------------------------------------ |
| 200  | OK                    | The request was successful.                            |
| 401  | Unauthorized          | The request was rejected due to an invalid access key. |
| 500  | Internal server error | The request failed due to an internal server error.    |


# Pdf
Source: https://docs.screenshotmax.com/endpoints/get-pdf

GET https://api.screenshotmax.com/v1/pdf
Generate a PDF from a webpage.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the pdf of the webpage.

## Getting started

### REST

The PDF API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The PDF API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The PDF API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/pdf
```

### Validation endpoint

ScreenshotMAX’s PDF API simply requires your unique access key and url to be passed in the URL. The API will return a pdf of the webpage.

```
https://api.screenshotmax.co/v1/pdf
?access_key=YOUR_ACCESS_KEY
&url=https://example.com
```

This was a successful request, so the API returned a 200 OK response. The pdf is returned in the body of the response.

### Request parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField query="url" type="string" initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  **Either `url` or `html` must be provided.**

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField query="html" type="string">
  This parameter allows you to provide raw HTML content to render and capture as a screenshot.
  It must be a valid HTML string.

  **Either `url` or `html` must be provided.**

  Example:
  `html=<html><body><h1>Hello, World!</h1></body></html>`
</ParamField>

<ParamField query="pdf_paper_format" type="string" default="letter">
  Available options include: are `letter`, `legal`, `tabloid`, `ledger`, `a0`, `a1`, `a2`, `a3`, `a4`, `a5`, `a6`.
  Use this setting to control the dimensions of the output when generating PDF documents.
</ParamField>

<ParamField query="pdf_landscape" type="bool" default="false">
  Defines the orientation of the webpage when rendering as a PDF. `true` for landscape and `false` for portrait.
</ParamField>

<ParamField query="pdf_print_background" type="bool" default="false">
  Print background colors and images. `true` to print background colors and images, `false` to not print background colors and images.
</ParamField>

<ParamField query="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField query="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField query="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField query="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField query="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField query="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField query="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField query="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField query="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField query="clip_x" type="number">
  The x-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField query="clip_y" type="number">
  The y-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField query="clip_width" type="number">
  The width of the clipping region.
</ParamField>

<ParamField query="clip_height" type="number">
  The height of the clipping region.
</ParamField>

<ParamField query="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField query="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField query="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField query="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField query="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField query="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField query="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField query="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField query="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField query="hide_selectors" type="string[]">
  The selectors to hide in the content. This allows you to remove specific elements from the rendering.
  Example: `hide_selectors=div.header,div.footer`.
</ParamField>

<ParamField query="click_selector" type="string">
  The selector to click in the content. This allows you to interact with specific elements before the rendering.
  Example: `click_selector=button.submit`.
</ParamField>

<ParamField query="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField query="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField query="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField query="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField query="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField query="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField query="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField query="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField query="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField query="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField query="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField query="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField query="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField query="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField query="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField query="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField query="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField query="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField query="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField query="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField query="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture content without blocking the request.
</ParamField>

<ParamField query="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="signature" type="string">
  The cryptographic signature used to verify the authenticity of the request.
  For more information on how to compute and validate this signature, see the [signed requests documentation](https://docs.screenshotmax.com/start/signed-request").
</ParamField>

## Response and error codes

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Scrape
Source: https://docs.screenshotmax.com/endpoints/get-scrape

GET https://api.screenshotmax.com/v1/scrape
Scrape data from webpages.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the content of the webpage.

## Getting started

### REST

The Scrape API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Scrape API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Scrape API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/scrape
```

### Validation endpoint

ScreenshotMAX’s Scrape API simply requires your unique access key and url to be passed in the URL. The API will return the content of the webpage.

```
https://api.screenshotmax.co/v1/scrape
?access_key=YOUR_ACCESS_KEY
&url=https://example.com
```

This was a successful request, so the API returned a 200 OK response. The content of the webpage is returned in the body of the response.

### Request parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField query="url" type="string" required initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField query="format" type="string" default="html">
  The format of the screenshot. Available formats are `html`, `md`.
  The `html` format returns the HTML content of the webpage, while the `md` format returns the content in Markdown format.
</ParamField>

<ParamField query="js_enabled" type="bool" default="true">
  Whether to enable JavaScript on the page. If set to `false`, the API will return the HTML content of the page without executing any JavaScript.
</ParamField>

<ParamField query="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField query="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField query="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField query="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField query="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField query="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField query="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField query="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField query="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField query="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField query="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField query="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField query="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField query="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField query="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField query="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField query="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField query="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField query="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField query="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField query="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField query="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField query="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField query="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField query="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField query="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField query="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField query="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField query="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField query="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField query="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField query="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField query="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField query="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField query="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField query="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField query="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField query="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField query="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField query="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture content without blocking the request.
</ParamField>

<ParamField query="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="signature" type="string">
  The cryptographic signature used to verify the authenticity of the request.
  For more information on how to compute and validate this signature, see the [signed requests documentation](https://docs.screenshotmax.com/start/signed-request").
</ParamField>

## Response and error codes

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Screencast
Source: https://docs.screenshotmax.com/endpoints/get-screencast

GET https://api.screenshotmax.com/v1/screencast
Capture high-quality animated screenshots of webpages.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the animated screenshot of the webpage.

## Getting started

### REST

The Screencast API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Screencast API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Screencast API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/screencast
```

### Validation endpoint

ScreenshotMAX’s Screencast API simply requires your unique access key and url to be passed in the URL. The API will return an animated screenshot of the webpage.

```
https://api.screenshotmax.co/v1/screencast
?access_key=YOUR_ACCESS_KEY
&url=https://example.com
```

This was a successful request, so the API returned a 200 OK response. The animated screenshot is returned in the body of the response.

### Request parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField query="url" type="string" required initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField query="format" type="string" default="mp4">
  The format of the animated screenshot. Available formats are `webm`, `mp4`, `mov`, `avi`.
</ParamField>

<ParamField query="duration" type="number" default="5">
  The duration of the animated screenshot in seconds. The default value is `5` seconds. Maximum value is `30` seconds.
</ParamField>

<ParamField query="scenario" type="string" default="video">
  The scenario of the animated screenshot. Available scenarios are `video`, and `scroll`.
  The `video` scenario captures the entire webpage as a video. The `scroll` scenario captures the webpage by scrolling down.
</ParamField>

<ParamField query="scroll_by_amount" type="number" default="1000">
  The `scroll_by_amount` parameter is only applicable for the `scroll` scenario. It specifies the amount to scroll in pixels for one step. The default value is `1000` pixels.
</ParamField>

<ParamField query="scroll_by_delay" type="number" default="500">
  The `scroll_by_delay` parameter is only applicable for the `scroll` scenario. It specifies the delay between each scroll in milliseconds. The default value is `500` milliseconds.
</ParamField>

<ParamField query="scroll_by_duration" type="number" default="1500">
  The `scroll_by_duration` parameter is only applicable for the `scroll` scenario. It specifies the total duration for all steps of scrolls in milliseconds. The default value is `1500` milliseconds.
</ParamField>

<ParamField query="scroll_back" type="bool" default="true">
  The `scroll_back` parameter is only applicable for the `scroll` scenario. When set to `true`, the animated screenshot will scroll back to the top of the page after reaching the bottom.
</ParamField>

<ParamField query="scroll_back_delay" type="number" default="800">
  The `scroll_back_delay` parameter is only applicable for the `scroll` scenario. It specifies the delay before scrolling back to the top in milliseconds. The default value is `800` milliseconds.
</ParamField>

<ParamField query="scroll_easing" type="string" default="linear">
  The `scroll_easing` parameter is only applicable for the `scroll` scenario. It specifies the easing function to use for the scroll animation.
  Available values are `linear`, `ease_in_quad`, `ease_out_quad`, `ease_in_out_quad`, `ease_in_cubic`, `ease_out_cubic`, `ease_in_out_cubic`, `ease_in_quart`, `ease_out_quart`, `ease_in_out_quart`, `ease_in_quint`, `ease_out_quint` and `ease_in_out_quint`.
</ParamField>

<ParamField query="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField query="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField query="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField query="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField query="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField query="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField query="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField query="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField query="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField query="clip_x" type="number">
  The x-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField query="clip_y" type="number">
  The y-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField query="clip_width" type="number">
  The width of the clipping region.
</ParamField>

<ParamField query="clip_height" type="number">
  The height of the clipping region.
</ParamField>

<ParamField query="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField query="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField query="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField query="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField query="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField query="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField query="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField query="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField query="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField query="hide_selectors" type="string[]">
  The selectors to hide in the content. This allows you to remove specific elements from the rendering.
  Example: `hide_selectors=div.header,div.footer`.
</ParamField>

<ParamField query="click_selector" type="string">
  The selector to click in the content. This allows you to interact with specific elements before the rendering.
  Example: `click_selector=button.submit`.
</ParamField>

<ParamField query="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField query="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField query="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField query="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField query="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField query="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField query="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField query="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField query="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField query="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField query="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField query="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField query="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField query="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField query="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField query="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField query="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField query="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField query="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField query="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField query="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture content without blocking the request.
</ParamField>

<ParamField query="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="signature" type="string">
  The cryptographic signature used to verify the authenticity of the request.
  For more information on how to compute and validate this signature, see the [signed requests documentation](https://docs.screenshotmax.com/start/signed-request").
</ParamField>

## Response and error codes

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Screenshot
Source: https://docs.screenshotmax.com/endpoints/get-screenshot

GET https://api.screenshotmax.com/v1/screenshot
Capture high-quality screenshots of webpages.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the screenshot of the webpage.

## Getting started

### REST

The Screenshot API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Screenshot API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Screenshot API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/screenshot
```

### Validation endpoint

ScreenshotMAX’s Screenshot API simply requires your unique access key and url to be passed in the URL. The API will return a screenshot of the webpage.

```
https://api.screenshotmax.com/v1/screenshot
?access_key=YOUR_ACCESS_KEY
&url=https://example.com
```

This was a successful request, so the API returned a 200 OK response. The screenshot is returned in the body of the response.

### Request parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField query="url" type="string" initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  **Either `url` or `html` must be provided.**

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField query="html" type="string">
  This parameter allows you to provide raw HTML content to render and capture as a screenshot.
  It must be a valid HTML string.

  **Either `url` or `html` must be provided.**

  Example:
  `html=<html><body><h1>Hello, World!</h1></body></html>`
</ParamField>

<ParamField query="format" type="string" default="jpeg">
  The format of the screenshot. Available formats are `jpeg`, `jpg`, `png`, `webp`, `gif`. `jpg` is an alias for `jpeg`.
</ParamField>

<ParamField query="image_quality" type="number" default="80">
  The quality of the image. This parameter is only applicable for `jpeg`, `jpg`, `webp` formats. Allowed values range from `1` to `100`.
</ParamField>

<ParamField query="image_width" type="number">
  The `image_width` and `image_height` parameters let you generate a thumbnail version of the screenshot.
  When specified, the screenshot is resized to fit within the given width and height while preserving the aspect ratio. The image will be as large as possible without exceeding the specified dimensions.\
  If only one parameter is provided, the other is automatically calculated to maintain the aspect ratio.
</ParamField>

<ParamField query="image_height" type="number">
  The `image_width` and `image_height` parameters let you generate a thumbnail version of the screenshot.
  When specified, the screenshot is resized to fit within the given width and height while preserving the aspect ratio. The image will be as large as possible without exceeding the specified dimensions.\
  If only one parameter is provided, the other is automatically calculated to maintain the aspect ratio.
</ParamField>

<ParamField query="omit_background" type="bool" default="false">
  Render a transparent background for the image. Works only if the site has not defined background color. Available for the following response formats: `png`, `webp`.
</ParamField>

<ParamField query="full_page" type="bool" default="false">
  Whether to take a full page screenshot.
</ParamField>

<ParamField query="full_page_scroll" type="bool" default="false">
  Whether to scroll the page to take a full page screenshot. This is useful for pages that load content dynamically as you scroll.
</ParamField>

<ParamField query="full_page_scroll_by_amount" type="number">
  The amount of pixels to scroll per step.
</ParamField>

<ParamField query="full_page_scroll_by_duration" type="number" default="400">
  The duration in milliseconds for each step.
</ParamField>

<ParamField query="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField query="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField query="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField query="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField query="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField query="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField query="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField query="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField query="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField query="clip_x" type="number">
  The x-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField query="clip_y" type="number">
  The y-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField query="clip_width" type="number">
  The width of the clipping region.
</ParamField>

<ParamField query="clip_height" type="number">
  The height of the clipping region.
</ParamField>

<ParamField query="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField query="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField query="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField query="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField query="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField query="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField query="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField query="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField query="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField query="hide_selectors" type="string[]">
  The selectors to hide in the content. This allows you to remove specific elements from the rendering.
  Example: `hide_selectors=div.header,div.footer`.
</ParamField>

<ParamField query="click_selector" type="string">
  The selector to click in the content. This allows you to interact with specific elements before the rendering.
  Example: `click_selector=button.submit`.
</ParamField>

<ParamField query="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField query="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField query="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField query="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField query="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField query="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField query="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField query="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField query="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField query="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField query="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField query="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField query="metadata_image_size" type="bool" default="false">
  Whether to include the metadata image width and height in the screenshot. This allows you to capture the dimensions of the screenshot. The dimensions will be included in the header `X-Screenshotmax-Metadata-Image-Size`.
</ParamField>

<ParamField query="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField query="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField query="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField query="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField query="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField query="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField query="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField query="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField query="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture content without blocking the request.
</ParamField>

<ParamField query="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField query="signature" type="string">
  The cryptographic signature used to verify the authenticity of the request.
  For more information on how to compute and validate this signature, see the [signed requests documentation](https://docs.screenshotmax.com/start/signed-request").
</ParamField>

## Response and error codes

The API response is returned in binary format. The response is a screenshot of the webpage in the specified format. The response headers include the following:

* `Content-Type`: The content type of the response. This indicates the format of the screenshot.
* `Content-Disposition`: The content disposition of the response. This indicates how the screenshot should be handled by the browser. If the `attachment_name` parameter is provided, the filename will be included in this header.
* `X-Screenshotmax-Request-Id`: The unique identifier for the request. This can be used to track the request in the logs.
* `X-Screenshotmax-Metadata-Icon`: The URL of the icon of the webpage. This is only included if the `metadata_icon` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Title`: The title of the webpage. This is only included if the `metadata_title` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Fonts`: The fonts used on the webpage. This is only included if the `metadata_fonts` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Hash`: The hash of the screenshot. This is only included if the `metadata_hash` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Status`: The HTTP status code of the webpage. This is only included if the `metadata_status` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Headers`: The headers of the webpage. This is only included if the `metadata_headers` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Image-Size`: The dimensions of the screenshot. This is only included if the `metadata_image_size` parameter is set to `true`.

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# List Tasks
Source: https://docs.screenshotmax.com/endpoints/get-tasks

GET https://api.screenshotmax.com/v1/tasks
Get all your scheduled tasks

It’s simple to use: you only need to submit your `access_key`. The API will return the list of your scheduled tasks for your account.

<Warning>
  **Plan Requirement**

  Scheduled Tasks are available only on the **Scale plan**.
  Upgrade your account via the Subscription / Dashboard [section](https://app.screenshotmax.com/subscribe/monthly) to unlock this feature.
</Warning>

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Task API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST and PATCH requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/tasks
```

### Validation endpoint

ScreenshotMAX’s Task API simply requires your unique access key. The API will return the list of your scheduled tasks for your account.

```
https://api.screenshotmax.com/v1/tasks
? access_key=YOUR_ACCESS_KEY
```

This was a successful request, so the API returned a 200 OK response with the list of your scheduled tasks for your account.

```json
{
  [
    {
      "id": 5650820808835072,
      "name": "task screenshot",
      "api": "screenshot",
      "query": "url=https%3A%2F%2Fexample.com",
      "frequency": "every_month",
      "crontab": "34 9 28 * *",
      "timezone": "Etc/UTC",
      "enabled": true,
      "created": 1714296566,
      "last_run": 1745832566,
      "runs": 12
    },
    ...
  ]
}
```

### Query parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

### Response parameters

The API response is returned in a universal and lightweight [JSON format](https://www.json.org/json-en.html).

<ResponseField name="tasks" type="object[]">
  <Expandable title="properties">
    <ResponseField name="id" type="number">
      Unique identifier for the scheduled task. This ID is automatically generated when you create a new scheduled task.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the scheduled task.
    </ResponseField>

    <ResponseField name="api" type="string">
      Service to be used for the scheduled task. Available options include `screenshot`, `screencast`, `pdf` and `scrape`.
    </ResponseField>

    <ResponseField name="query" type="string">
      Query parameters for the scheduled task without the `access_key` parameter.
      The querystring can be URL-encoded.

      For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com`.
    </ResponseField>

    <ResponseField name="frequency" type="string">
      Frequency of the scheduled task. Available options are `every_minute`, `every_hour`, `every_day`, `every_month` and `custom` (use standard cron syntax).
    </ResponseField>

    <ResponseField name="crontab" type="string">
      Cron expression used to the scheduled task. Use [Unix Cron Format](https://crontab-generator.com/en)
    </ResponseField>

    <ResponseField name="timezone" type="string">
      Timezone for the scheduled task. Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
    </ResponseField>

    <ResponseField name="enabled" type="boolean">
      Indicates if the scheduled task is enabled or disabled.
    </ResponseField>

    <ResponseField name="created" type="number">
      Unix timestamp in seconds when the scheduled task was created.
    </ResponseField>

    <ResponseField name="last_run" type="number">
      Unix timestamp in seconds when the scheduled task was last run.
    </ResponseField>

    <ResponseField name="runs" type="number">
      Number of times the scheduled task has run.
    </ResponseField>
  </Expandable>
</ResponseField>

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                          |
| ---- | --------------------- | ---------------------------------------------------------------- |
| 200  | OK                    | The request was successful.                                      |
| 401  | Unauthorized          | The request was rejected due to an invalid access key.           |
| 402  | Payment Required      | Access denied due to an unpaid invoice.                          |
| 423  | Locked                | The request was denied due to insufficient quota.                |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute). |
| 500  | Internal server error | The request failed due to an internal server error.              |


# Get Task
Source: https://docs.screenshotmax.com/endpoints/get-tasks-id

GET https://api.screenshotmax.com/v1/tasks/{id}
Get a scheduled task

It’s simple to use: you only need to submit your `access_key`. The API will return the list of your scheduled tasks for your account.

<Warning>
  **Plan Requirement**

  Scheduled Tasks are available only on the **Scale plan**.
  Upgrade your account via the Subscription / Dashboard [section](https://app.screenshotmax.com/subscribe/monthly) to unlock this feature.
</Warning>

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Task API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST and PATCH requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/tasks
```

### Validation endpoint

ScreenshotMAX’s Task API simply requires your unique access key. The API will return the scheduled task.

```
https://api.screenshotmax.com/v1/tasks/5650820808835072
? access_key=YOUR_ACCESS_KEY
```

This was a successful request, so the API returned a 200 OK response with the scheduled task.

```json
{
  "id": 5650820808835072,
  "name": "task screenshot",
  "api": "screenshot",
  "query": "url=https%3A%2F%2Fexample.com",
  "frequency": "every_month",
  "crontab": "34 9 28 * *",
  "timezone": "Etc/UTC",
  "enabled": true,
  "created": 1714296566,
  "last_run": 1745832566,
  "runs": 12
}
```

### Path parameters

<ParamField path="id" type="string" required>
  Unique identifier for the scheduled task.
</ParamField>

### Query parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

### Response parameters

The API response is returned in a universal and lightweight [JSON format](https://www.json.org/json-en.html).

<ResponseField name="id" type="number">
  Unique identifier for the scheduled task. This ID is automatically generated when you create a new scheduled task.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the scheduled task.
</ResponseField>

<ResponseField name="api" type="string">
  Service to be used for the scheduled task. Available options include `screenshot`, `screencast`, `pdf` and `scrape`.
</ResponseField>

<ResponseField name="query" type="string">
  Query parameters for the scheduled task without the `access_key` parameter.
  The querystring can be URL-encoded.

  For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com`.
</ResponseField>

<ResponseField name="frequency" type="string">
  Frequency of the scheduled task. Available options are `every_minute`, `every_hour`, `every_day`, `every_month` and `custom` (use standard cron syntax).
</ResponseField>

<ResponseField name="crontab" type="string">
  Cron expression used to the scheduled task. Use [Unix Cron Format](https://crontab-generator.com/en)
</ResponseField>

<ResponseField name="timezone" type="string">
  Timezone for the scheduled task. Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ResponseField>

<ResponseField name="enabled" type="boolean">
  Indicates if the scheduled task is enabled or disabled.
</ResponseField>

<ResponseField name="created" type="number">
  Unix timestamp in seconds when the scheduled task was created.
</ResponseField>

<ResponseField name="last_run" type="number">
  Unix timestamp in seconds when the scheduled task was last run.
</ResponseField>

<ResponseField name="runs" type="number">
  Number of times the scheduled task has run.
</ResponseField>

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                          |
| ---- | --------------------- | ---------------------------------------------------------------- |
| 200  | OK                    | The request was successful.                                      |
| 400  | Bad Request           | The request was rejected due to a missing or invalid parameter.  |
| 401  | Unauthorized          | The request was rejected due to an invalid access key.           |
| 402  | Payment Required      | Access denied due to an unpaid invoice.                          |
| 404  | Not Found             | The requested resource was not found.                            |
| 423  | Locked                | The request was denied due to insufficient quota.                |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute). |
| 500  | Internal server error | The request failed due to an internal server error.              |


# Update Task
Source: https://docs.screenshotmax.com/endpoints/patch-tasks

PATCH https://api.screenshotmax.com/v1/tasks/{id}
Update a scheduled task

It’s simple to use: you only need to submit your `access_key` and the payload. The API will return the scheduled task updated.

<Warning>
  **Plan Requirement**

  Scheduled Tasks are available only on the **Scale plan**.
  Upgrade your account via the Subscription / Dashboard [section](https://app.screenshotmax.com/subscribe/monthly) to unlock this feature.
</Warning>

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Task API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST and PATCH requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/tasks/
```

### Validation endpoint

ScreenshotMAX’s Task API simply requires your unique access key. The API will return the scheduled task updated.

```json
PATCH https://api.screenshotmax.com/v1/tasks/5650820808835072
{
  "access_key": "YOUR_ACCESS_KEY",
  "name": "task screenshot",
  "api": "screenshot",
  "query": "url=https%3A%2F%2Fexample.com",
  "frequency": "every_month",
  "timezone": "Etc/UTC",
  "enabled": true
}
```

This was a successful request, so the API returned a 201 OK response with the updated scheduled task.

```json
{
  "id": 5650820808835072,
  "name": "task screenshot",
  "api": "screenshot",
  "query": "url=https%3A%2F%2Fexample.com",
  "frequency": "every_month",
  "crontab": "34 9 28 * *",
  "timezone": "Etc/UTC",
  "enabled": true,
  "created": 1714296566,
  "last_run": 1745832566,
  "runs": 12
}
```

### Path parameters

<ParamField path="id" type="number" required>
  Unique identifier for the scheduled task.
</ParamField>

### Body parameters

<ParamField body="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField body="name" type="string">
  Name of the scheduled task. The maximum length is 100 characters.
</ParamField>

<ParamField body="api" type="string">
  Service to be used for the scheduled task. Available options include:

  * `screenshot`
  * `screencast`
  * `pdf`
  * `scrape`
</ParamField>

<ParamField body="query" type="string">
  Query parameters for the scheduled task without the `access_key` parameter.
  The querystring can be URL-encoded.

  For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com`.
</ParamField>

<ParamField body="frequency" type="string">
  Frequency of the scheduled task. Available options are:

  * `every_minute`
  * `every_hour`
  * `every_day`
  * `every_month`
  * `custom` (use standard cron syntax)
</ParamField>

<ParamField body="crontab" type="string">
  **Optional** - Only available if the `frequency` is set to `custom`.
  Cron expression used to the scheduled task. You can create one easily using the [Unix Cron Format](http://crontab.org) with this tool [Unix Cron Generator](https://crontab-generator.com/en).

  The cron expression is a string that represents a schedule in the Unix cron format. It consists of five fields separated by spaces, each representing a different unit of time.
  The fields are:

  * minute (0-59)
  * hour (0-23)
  * day of the month (1-31)
  * month (1-12)
  * day of the week (0-6, where 0 is Sunday)
    The cron expression can also include special characters such as `*` (any value), `,` (list of values), `-` (range of values), and `/` (step values).

  For example, the cron expression `34 9 28 * *` means "run at 9:34 AM on the 28th day of every month".
</ParamField>

<ParamField body="timezone" type="string" default="Etc/UTC">
  Timezone for the scheduled task. Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField body="enabled" type="boolean" default="true">
  Indicates if the scheduled task is enabled or disabled.
</ParamField>

### Response parameters

The API response is returned in a universal and lightweight [JSON format](https://www.json.org/json-en.html).

<ResponseField name="id" type="number">
  Unique identifier for the scheduled task. This ID is automatically generated when you create a new scheduled task.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the scheduled task.
</ResponseField>

<ResponseField name="api" type="string">
  Service to be used for the scheduled task. Available options include `screenshot`, `screencast`, `pdf` and `scrape`.
</ResponseField>

<ResponseField name="query" type="string">
  Query parameters for the scheduled task without the `access_key` parameter.
  The querystring can be URL-encoded.

  For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com`.
</ResponseField>

<ResponseField name="frequency" type="string">
  Frequency of the scheduled task. Available options are `every_minute`, `every_hour`, `every_day`, `every_month` and `custom` (use standard cron syntax).
</ResponseField>

<ResponseField name="crontab" type="string">
  Cron expression used to the scheduled task. Use [Unix Cron Format](https://crontab-generator.com/en)
</ResponseField>

<ResponseField name="timezone" type="string">
  Timezone for the scheduled task. Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ResponseField>

<ResponseField name="enabled" type="boolean">
  Indicates if the scheduled task is enabled or disabled.
</ResponseField>

<ResponseField name="created" type="number">
  Unix timestamp in seconds when the scheduled task was created.
</ResponseField>

<ResponseField name="last_run" type="number">
  Unix timestamp in seconds when the scheduled task was last run.
</ResponseField>

<ResponseField name="runs" type="number">
  Number of times the scheduled task has run.
</ResponseField>

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                          |
| ---- | --------------------- | ---------------------------------------------------------------- |
| 201  | OK                    | The request was successful.                                      |
| 400  | Bad Request           | The request was rejected due to a missing or invalid parameter.  |
| 401  | Unauthorized          | The request was rejected due to an invalid access key.           |
| 402  | Payment Required      | Access denied due to an unpaid invoice.                          |
| 404  | Not Found             | The requested resource was not found.                            |
| 423  | Locked                | The request was denied due to insufficient quota.                |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute). |
| 500  | Internal server error | The request failed due to an internal server error.              |


# Pdf
Source: https://docs.screenshotmax.com/endpoints/post-pdf

POST https://api.screenshotmax.com/v1/pdf
Generate a PDF from a webpage.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the pdf of the webpage.

## Getting started

### REST

The PDF API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The PDF API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The PDF API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
You have to include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/pdf
```

### Validation endpoint

ScreenshotMAX’s PDF API simply requires your unique access key and url to be passed in the URL. The API will return a pdf of the webpage.

```json
POST https://api.screenshotmax.com/v1/pdf
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}
```

This was a successful request, so the API returned a 200 OK response. The pdf is returned in the body of the response.

### Request parameters

<ParamField body="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField body="url" type="string" initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  **Either `url` or `html` must be provided.**

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField body="html" type="string">
  This parameter allows you to provide raw HTML content to render and capture as a screenshot.
  It must be a valid HTML string.

  **Either `url` or `html` must be provided.**

  Example:
  `html=<html><body><h1>Hello, World!</h1></body></html>`
</ParamField>

<ParamField body="pdf_paper_format" type="string" default="letter">
  Available options include: are `letter`, `legal`, `tabloid`, `ledger`, `a0`, `a1`, `a2`, `a3`, `a4`, `a5`, `a6`.
  Use this setting to control the dimensions of the output when generating PDF documents.
</ParamField>

<ParamField body="pdf_landscape" type="bool" default="false">
  Defines the orientation of the webpage when rendering as a PDF. `true` for landscape and `false` for portrait.
</ParamField>

<ParamField body="pdf_print_background" type="bool" default="false">
  Print background colors and images. `true` to print background colors and images, `false` to not print background colors and images.
</ParamField>

<ParamField body="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField body="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField body="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField body="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField body="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField body="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField body="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField body="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField body="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField body="clip_x" type="number">
  The x-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField body="clip_y" type="number">
  The y-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField body="clip_width" type="number">
  The width of the clipping region.
</ParamField>

<ParamField body="clip_height" type="number">
  The height of the clipping region.
</ParamField>

<ParamField body="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField body="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField body="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField body="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField body="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField body="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField body="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField body="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField body="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField body="hide_selectors" type="string[]">
  The selectors to hide in the content. This allows you to remove specific elements from the rendering.
  Example: `hide_selectors=div.header,div.footer`.
</ParamField>

<ParamField body="click_selector" type="string">
  The selector to click in the content. This allows you to interact with specific elements before the rendering.
  Example: `click_selector=button.submit`.
</ParamField>

<ParamField body="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField body="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField body="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField body="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField body="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField body="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField body="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField body="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField body="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField body="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField body="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField body="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField body="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField body="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField body="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField body="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField body="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField body="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField body="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField body="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField body="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture screenshots without blocking the request.
</ParamField>

<ParamField body="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField body="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

## Response and error codes

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Scrape
Source: https://docs.screenshotmax.com/endpoints/post-scrape

POST https://api.screenshotmax.com/v1/scrape
Scrape data from webpages.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the content of the webpage.

## Getting started

### REST

The Scrape API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Scrape API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Scrape API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
You have to include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/scrape
```

### Validation endpoint

ScreenshotMAX’s Scrape API simply requires your unique access key and url to be passed in the URL. The API will return the content of the webpage.

```json
POST https://api.screenshotmax.com/v1/scrape
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}
```

This was a successful request, so the API returned a 200 OK response. The content of the webpage is returned in the body of the response.

### Request parameters

<ParamField body="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField body="url" type="string" required initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField body="format" type="string" default="html">
  The format of the screenshot. Available formats are `html`, `md`.
  The `html` format returns the HTML content of the webpage, while the `md` format returns the content in Markdown format.
</ParamField>

<ParamField body="js_enabled" type="bool" default="true">
  Whether to enable JavaScript on the page. If set to `false`, the API will return the HTML content of the page without executing any JavaScript.
</ParamField>

<ParamField body="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField body="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField body="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField body="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField body="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField body="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField body="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField body="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField body="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField body="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField body="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField body="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField body="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField body="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField body="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField body="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField body="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField body="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField body="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField body="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField body="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField body="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField body="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField body="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField body="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField body="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField body="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField body="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField body="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField body="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField body="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField body="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField body="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField body="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField body="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField body="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField body="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField body="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField body="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField body="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture screenshots without blocking the request.
</ParamField>

<ParamField body="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField body="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

## Response and error codes

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Screencast
Source: https://docs.screenshotmax.com/endpoints/post-screencast

POST https://api.screenshotmax.com/v1/screencast
Capture high-quality animated screenshots of webpages.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the animated screenshot of the webpage.

## Getting started

### REST

The Screencast API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Screencast API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Screencast API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
You have to include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/screencast
```

### Validation endpoint

ScreenshotMAX’s Screencast API simply requires your unique access key and url to be passed in the URL. The API will return an animated screenshot of the webpage.

```json
POST https://api.screenshotmax.com/v1/screencast
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}
```

This was a successful request, so the API returned a 200 OK response. The animated screenshot is returned in the body of the response.

### Request parameters

<ParamField body="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField body="url" type="string" required initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField body="format" type="string" default="mp4">
  The format of the animated screenshot. Available formats are `webm`, `mp4`, `mov`, `avi`.
</ParamField>

<ParamField body="duration" type="number" default="5">
  The duration of the animated screenshot in seconds. The default value is `5` seconds. Maximum value is `30` seconds.
</ParamField>

<ParamField body="scenario" type="string" default="video">
  The scenario of the animated screenshot. Available scenarios are `video`, and `scroll`.
  The `video` scenario captures the entire webpage as a video. The `scroll` scenario captures the webpage by scrolling down.
</ParamField>

<ParamField body="scroll_by_amount" type="number" default="1000">
  The `scroll_by_amount` parameter is only applicable for the `scroll` scenario. It specifies the amount to scroll in pixels for one step. The default value is `1000` pixels.
</ParamField>

<ParamField body="scroll_by_delay" type="number" default="500">
  The `scroll_by_delay` parameter is only applicable for the `scroll` scenario. It specifies the delay between each scroll in milliseconds. The default value is `500` milliseconds.
</ParamField>

<ParamField body="scroll_by_duration" type="number" default="1500">
  The `scroll_by_duration` parameter is only applicable for the `scroll` scenario. It specifies the total duration for all steps of scrolls in milliseconds. The default value is `1500` milliseconds.
</ParamField>

<ParamField body="scroll_back" type="bool" default="true">
  The `scroll_back` parameter is only applicable for the `scroll` scenario. When set to `true`, the animated screenshot will scroll back to the top of the page after reaching the bottom.
</ParamField>

<ParamField body="scroll_back_delay" type="number" default="800">
  The `scroll_back_delay` parameter is only applicable for the `scroll` scenario. It specifies the delay before scrolling back to the top in milliseconds. The default value is `800` milliseconds.
</ParamField>

<ParamField body="scroll_easing" type="string" default="linear">
  The `scroll_easing` parameter is only applicable for the `scroll` scenario. It specifies the easing function to use for the scroll animation.
  Available values are `linear`, `ease_in_quad`, `ease_out_quad`, `ease_in_out_quad`, `ease_in_cubic`, `ease_out_cubic`, `ease_in_out_cubic`, `ease_in_quart`, `ease_out_quart`, `ease_in_out_quart`, `ease_in_quint`, `ease_out_quint` and `ease_in_out_quint`.
</ParamField>

<ParamField body="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField body="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField body="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField body="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField body="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField body="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField body="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField body="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField body="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField body="clip_x" type="number">
  The x-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField body="clip_y" type="number">
  The y-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField body="clip_width" type="number">
  The width of the clipping region.
</ParamField>

<ParamField body="clip_height" type="number">
  The height of the clipping region.
</ParamField>

<ParamField body="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField body="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField body="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField body="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField body="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField body="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField body="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField body="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField body="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField body="hide_selectors" type="string[]">
  The selectors to hide in the content. This allows you to remove specific elements from the rendering.
  Example: `hide_selectors=div.header,div.footer`.
</ParamField>

<ParamField body="click_selector" type="string">
  The selector to click in the content. This allows you to interact with specific elements before the rendering.
  Example: `click_selector=button.submit`.
</ParamField>

<ParamField body="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField body="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField body="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField body="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField body="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField body="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField body="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField body="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField body="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField body="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField body="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField body="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField body="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField body="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField body="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField body="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField body="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField body="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField body="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField body="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField body="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture screenshots without blocking the request.
</ParamField>

<ParamField body="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField body="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

## Response and error codes

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Screenshot
Source: https://docs.screenshotmax.com/endpoints/post-screenshot

POST https://api.screenshotmax.com/v1/screenshot
Capture high-quality screenshots of webpages.

It’s simple to use: you only need to submit your `access_key` and a url `url` of a webpage. The API will return the screenshot of the webpage.

## Getting started

### REST

The Screenshot API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Screenshot API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Screenshot API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX API.
You have to include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/screenshot
```

### Validation endpoint

ScreenshotMAX’s Screenshot API simply requires your unique access key and url to be passed in the URL. The API will return a screenshot of the webpage.

```json
POST https://api.screenshotmax.com/v1/screenshot
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}
```

This was a successful request, so the API returned a 200 OK response. The screenshot is returned in the body of the response.

### Request parameters

<ParamField body="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField body="url" type="string" initialValue="https://example.com">
  The URL of the webpage you want to rendering of. Must be a valid URL and accessible from the internet.
  If the URL contains a querystring, it must be URL-encoded.

  **Either `url` or `html` must be provided.**

  For example, `https://example.com/test?param=1` should be passed as `https%3A%2F%2Fexample.com%2Ftest%3Fparam%3D1`.
</ParamField>

<ParamField body="html" type="string">
  This parameter allows you to provide raw HTML content to render and capture as a screenshot.
  It must be a valid HTML string.

  **Either `url` or `html` must be provided.**

  Example:
  `html=<html><body><h1>Hello, World!</h1></body></html>`
</ParamField>

<ParamField body="format" type="string" default="jpeg">
  The format of the screenshot. Available formats are `jpeg`, `jpg`, `png`, `webp`, `gif`. `jpg` is an alias for `jpeg`.
</ParamField>

<ParamField body="image_quality" type="number" default="80">
  The quality of the image. This parameter is only applicable for `jpeg`, `jpg`, `webp` formats. Allowed values range from `1` to `100`.
</ParamField>

<ParamField body="image_width" type="number">
  The `image_width` and `image_height` parameters let you generate a thumbnail version of the screenshot.
  When specified, the screenshot is resized to fit within the given width and height while preserving the aspect ratio. The image will be as large as possible without exceeding the specified dimensions.\
  If only one parameter is provided, the other is automatically calculated to maintain the aspect ratio.
</ParamField>

<ParamField body="image_height" type="number">
  The `image_width` and `image_height` parameters let you generate a thumbnail version of the screenshot.
  When specified, the screenshot is resized to fit within the given width and height while preserving the aspect ratio. The image will be as large as possible without exceeding the specified dimensions.\
  If only one parameter is provided, the other is automatically calculated to maintain the aspect ratio.
</ParamField>

<ParamField body="omit_background" type="bool" default="false">
  Render a transparent background for the image. Works only if the site has not defined background color. Available for the following response formats: `png`, `webp`.
</ParamField>

<ParamField body="full_page" type="bool" default="false">
  Whether to take a full page screenshot.
</ParamField>

<ParamField body="full_page_scroll" type="bool" default="false">
  Whether to scroll the page to take a full page screenshot. This is useful for pages that load content dynamically as you scroll.
</ParamField>

<ParamField body="full_page_scroll_by_amount" type="number">
  The amount of pixels to scroll per step.
</ParamField>

<ParamField body="full_page_scroll_by_duration" type="number" default="400">
  The duration in milliseconds for each step.
</ParamField>

<ParamField body="gpu_rendering" type="bool" default="false">
  Whether to use GPU rendering. Only available for **scale paid plan.**
</ParamField>

<ParamField body="capture_beyond_viewport" type="bool" default="false">
  Whether to capture content beyond the viewport.
</ParamField>

<ParamField body="viewport_device" type="string">
  The device type for the viewport.
</ParamField>

<ParamField body="viewport_width" type="number" default="1280">
  The width of the viewport in pixels.
</ParamField>

<ParamField body="viewport_height" type="number" default="1080">
  The height of the viewport in pixels.
</ParamField>

<ParamField body="viewport_landscape" type="bool">
  Whether the viewport should be in landscape mode.
</ParamField>

<ParamField body="viewport_has_touch" type="bool">
  Whether the viewport has touch capabilities.
</ParamField>

<ParamField body="viewport_mobile" type="bool">
  Whether the viewport is a mobile device.
</ParamField>

<ParamField body="device_scale_factor" type="number">
  The device scale factor for the viewport.
</ParamField>

<ParamField body="clip_x" type="number">
  The x-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField body="clip_y" type="number">
  The y-coordinate of the top-left corner of the clipping region.
</ParamField>

<ParamField body="clip_width" type="number">
  The width of the clipping region.
</ParamField>

<ParamField body="clip_height" type="number">
  The height of the clipping region.
</ParamField>

<ParamField body="block_annoyance" type="string" default="cookies_banner">
  The annoyance to block. Options include `none`, `cookies_banner`, `ads`, `tracking`.
</ParamField>

<ParamField body="block_ressources" type="string">
  The resources to block. Options include `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` and `other`.
</ParamField>

<ParamField body="media_type" type="string" default="screen">
  The media type for the rendering. Options include `screen` and `print`.
</ParamField>

<ParamField body="vision_deficiency" type="string">
  The vision deficiency for the rendering. Options include `reduced_contrast`, `blurred_vision`, `deuteranopia`, `achromatopsia`.
</ParamField>

<ParamField body="dark_mode" type="bool" default="false">
  Whether to use dark mode for the rendering.
</ParamField>

<ParamField body="reduced_motion" type="bool" default="false">
  Whether to reduce motion for the rendering.
</ParamField>

<ParamField body="geolocation_accuracy" type="number">
  The accuracy of the geolocation in meters. Minimum is `0`. Maximum is `1000`.
</ParamField>

<ParamField body="geolocation_latitude" type="number">
  The latitude of the geolocation. Minimum is `-90`. Maximum is `90`.
</ParamField>

<ParamField body="geolocation_longitude" type="number">
  The longitude of the geolocation. Minimum is `-180`. Maximum is `180`.
</ParamField>

<ParamField body="hide_selectors" type="string[]">
  The selectors to hide in the content. This allows you to remove specific elements from the rendering.
  Example: `hide_selectors=div.header,div.footer`.
</ParamField>

<ParamField body="click_selector" type="string">
  The selector to click in the content. This allows you to interact with specific elements before the rendering.
  Example: `click_selector=button.submit`.
</ParamField>

<ParamField body="attachment_name" type="string">
  The name of the attachment, without the extension filename. This is the name that will be used when downloading the response.
  Extension will be automatically added based on the `format` parameter.
</ParamField>

<ParamField body="timezone" type="string">
  The time zone for the request. This allows you to simulate different time zones.
  Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField body="authorization" type="string">
  The authorization header to use for the request. This should be a base64-encoded string (e.g., for Basic Auth, encode "username:password" using base64). This allows you to authenticate with the webpage before capturing the content.
</ParamField>

<ParamField body="user_agent" type="string">
  The user agent to use for the request. This allows you to simulate different browsers and devices.
</ParamField>

<ParamField body="cookies" type="string[]">
  The cookies to use for the request. This allows you to simulate different sessions and states.
  Example: `cookies=name=value; name2=value2`.
</ParamField>

<ParamField body="headers" type="string[]">
  The headers to use for the request. This allows you to simulate different requests and responses.
  Example: `headers=header1:value1; header2:value2`.
</ParamField>

<ParamField body="ip_location" type="string">
  The IP location to use for the request. This allows you to simulate requests from different countries by routing them through proxy servers with corresponding IP addresses.
  This feature is only available on **scale paid plan**.

  Supported locations:

  * United States (`us`)
  * China (`cn`)
  * Europe (`eu`) (random EU country)
  * Canada (`ca`)
  * Mexico (`mx`)
  * United Kingdom (`gb`)
  * Germany (`de`)
  * France (`fr`)
  * Switzerland (`ch`)
  * India (`in`)
  * Japan (`jp`)
  * South Korea (`kr`)
  * Russia (`ru`)
  * Brazil (`br`)
  * Australia (`au`)
</ParamField>

<ParamField body="proxy" type="string">
  The proxy to use for the request. This allows you to route the request through a different IP address.
  The proxy must be in the format `http://username:password@host:port` or `https://username:password@host:port`.
</ParamField>

<ParamField body="bypass_csp" type="bool" default="false">
  Whether to bypass the Content Security Policy (CSP) of the webpage. This allows you to capture content of webpages with strict CSPs.
</ParamField>

<ParamField body="delay" type="number" default="0">
  The delay in seconds before rendering. This allows you to wait for specific elements to load before capturing the content. Maximum is `30`.
</ParamField>

<ParamField body="timeout" type="number" default="30">
  The timeout in seconds for the rendering. This allows you to set a maximum time for the request to complete. Maximum is `30`.
</ParamField>

<ParamField body="wait_until" type="string[]" default="['domcontentloaded']">
  The conditions to wait for before rendering. This allows you to ensure that specific elements are loaded before capturing the content.
  Available options include:

  * `load`: Wait for the load event to be fired.
  * `domcontentloaded`: Wait for the DOMContentLoaded event to be fired.
  * `networkidle0`: Wait for no network connections for at least 500 ms.
  * `networkidle2`: Wait for no more than 2 network connections to be active for at least 500 ms.
</ParamField>

<ParamField body="metadata_image_size" type="bool" default="false">
  Whether to include the metadata image width and height in the screenshot. This allows you to capture the dimensions of the screenshot. The dimensions will be included in the header `X-Screenshotmax-Metadata-Image-Size`.
</ParamField>

<ParamField body="metadata_icon" type="bool" default="false">
  Whether to include the metadata icon in the response. This allows you to capture the favicon of the webpage. The link of the icon will be included in the header `X-Screenshotmax-Metadata-Icon`.
</ParamField>

<ParamField body="metadata_title" type="bool" default="false">
  Whether to include the metadata title in the response. This allows you to capture the title of the webpage. The title will be included in the header `X-Screenshotmax-Metadata-Title`.
</ParamField>

<ParamField body="metadata_fonts" type="bool" default="false">
  Whether to include the metadata fonts in the response. This allows you to capture the fonts used on the webpage. The fonts will be included in the header `X-Screenshotmax-Metadata-Fonts`.
</ParamField>

<ParamField body="metadata_hash" type="bool" default="false">
  Whether to include the metadata hash in the response. This allows you to capture the hash of the webpage. The hash will be included in the header `X-Screenshotmax-Metadata-Hash`.
</ParamField>

<ParamField body="metadata_status" type="bool" default="false">
  Whether to include the metadata status in the response. This allows you to capture the HTTP status code of the webpage. The status code will be included in the header `X-Screenshotmax-Metadata-Status`.
</ParamField>

<ParamField body="metadata_headers" type="bool" default="false">
  Whether to include the metadata headers in the response. This allows you to capture the headers of the webpage. The headers will be included in the header `X-Screenshotmax-Metadata-Headers`.
</ParamField>

<ParamField body="cache" type="bool" default="false">
  Whether to store the content of the rendering in the cache. This allows you to store the rendered content for a specified time-to-live (TTL) period.
</ParamField>

<ParamField body="cache_ttl" type="number" default="604800">
  The time-to-live (TTL) for the cache in seconds. This allows you to set a maximum time for the cached resources to be valid. Maximum is 30 days in seconds (`2592000`).
</ParamField>

<ParamField body="async" type="bool" default="false">
  Whether to use asynchronous processing for the requestt. This allows you to capture screenshots without blocking the request.
</ParamField>

<ParamField body="webhook_url" type="string">
  The callback URL for asynchronous processing. This allows you to receive the response via a webhook.
  The webhook will be triggered when the response is ready.
  The webhook URL must be a valid URL and must be accessible from the internet.
  The webhook URL must be HTTPS and must support the `POST` method.
  More information about webhooks can be found in the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

<ParamField body="webhook_signed" type="bool" default="true">
  Indicates whether the webhook request should be signed. Enabling this option allows you to verify the authenticity of incoming webhook requests.
  For more details, refer to the [async & webhook documentation](https://docs.screenshotmax.com/start/async-webhooks).
</ParamField>

## Response and error codes

The API response is returned in binary format. The response is a screenshot of the webpage in the specified format. The response headers include the following:

* `Content-Type`: The content type of the response. This indicates the format of the screenshot.
* `Content-Disposition`: The content disposition of the response. This indicates how the screenshot should be handled by the browser. If the `attachment_name` parameter is provided, the filename will be included in this header.
* `X-Screenshotmax-Request-Id`: The unique identifier for the request. This can be used to track the request in the logs.
* `X-Screenshotmax-Metadata-Icon`: The URL of the icon of the webpage. This is only included if the `metadata_icon` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Title`: The title of the webpage. This is only included if the `metadata_title` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Fonts`: The fonts used on the webpage. This is only included if the `metadata_fonts` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Hash`: The hash of the screenshot. This is only included if the `metadata_hash` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Status`: The HTTP status code of the webpage. This is only included if the `metadata_status` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Headers`: The headers of the webpage. This is only included if the `metadata_headers` parameter is set to `true`.
* `X-Screenshotmax-Metadata-Image-Size`: The dimensions of the screenshot. This is only included if the `metadata_image_size` parameter is set to `true`.

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                                                                      |
| ---- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| 200  | OK                    | The request was successful.                                                                                  |
| 400  | Bad request           | The request was malformed or invalid.                                                                        |
| 401  | Unauthorized          | The request was rejected due to an invalid access key or missing signature when signed requests are enabled. |
| 403  | Forbidden             | The signature provided is invalid. Occurs when signed requests are enabled.                                  |
| 402  | Payment Required      | Access denied due to an unpaid invoice. **Applies to paid plans.**                                           |
| 423  | Locked                | The request was denied due to insufficient quota.                                                            |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute).                                             |
| 500  | Internal server error | The request failed due to an internal server error.                                                          |


# Create Task
Source: https://docs.screenshotmax.com/endpoints/post-tasks

POST https://api.screenshotmax.com/v1/tasks
Create a new scheduled task

It’s simple to use: you only need to submit your `access_key` and the payload. The API will return the new scheduled task created.

<Warning>
  **Plan Requirement**

  Scheduled Tasks are available only on the **Scale plan**.
  Upgrade your account via the Subscription / Dashboard [section](https://app.screenshotmax.com/subscribe/monthly) to unlock this feature.
</Warning>

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Task API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Task API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Task API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST and PATCH requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/tasks
```

### Validation endpoint

ScreenshotMAX’s Task API simply requires your unique access key. The API will return the list of your scheduled tasks for your account.

```json
POST https://api.screenshotmax.com/v1/tasks
{
  "access_key": "YOUR_ACCESS_KEY",
  "name": "task screenshot",
  "api": "screenshot",
  "query": "url=https%3A%2F%2Fexample.com",
  "frequency": "every_month",
  "crontab": "34 9 28 * *",
  "timezone": "Etc/UTC",
  "enabled": true
}
```

This was a successful request, so the API returned a 201 OK response with the new scheduled task for your account.

```json
{
  "id": 5650820808835072,
  "name": "task screenshot",
  "api": "screenshot",
  "query": "url=https%3A%2F%2Fexample.com",
  "frequency": "every_month",
  "crontab": "34 9 28 * *",
  "timezone": "Etc/UTC",
  "enabled": true,
  "created": 1714296566,
  "last_run": 1745832566,
  "runs": 12
}
```

### Body parameters

<ParamField body="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

<ParamField body="name" type="string" required>
  Name of the scheduled task. The maximum length is 100 characters.
</ParamField>

<ParamField body="api" type="string" required>
  Api endpoint for the scheduled task. Available options are:

  * `screenshot`
  * `screencast`
  * `pdf`
  * `scrape`
</ParamField>

<ParamField body="query" type="string" required>
  Query parameters for the scheduled task without the `access_key` parameter.
  The querystring can be URL-encoded.

  For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com`.
</ParamField>

<ParamField body="frequency" type="string" required>
  Frequency of the scheduled task. Available options are:

  * `every_minute`
  * `every_hour`
  * `every_day`
  * `every_month`
  * `custom` (use standard cron syntax)
</ParamField>

<ParamField body="crontab" type="string">
  **Optional** - Only available if the `frequency` is set to `custom`.
  Cron expression used to the scheduled task. You can create one easily using the [Unix Cron Format](http://crontab.org) with this tool [Unix Cron Generator](https://crontab-generator.com/en).

  The cron expression is a string that represents a schedule in the Unix cron format. It consists of five fields separated by spaces, each representing a different unit of time.
  The fields are:

  * minute (0-59)
  * hour (0-23)
  * day of the month (1-31)
  * month (1-12)
  * day of the week (0-6, where 0 is Sunday)
    The cron expression can also include special characters such as `*` (any value), `,` (list of values), `-` (range of values), and `/` (step values).

  For example, the cron expression `34 9 28 * *` means "run at 9:34 AM on the 28th day of every month".
</ParamField>

<ParamField body="timezone" type="string" default="Etc/UTC">
  Timezone for the scheduled task. Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ParamField>

<ParamField body="enabled" type="boolean" default="true">
  Indicates if the scheduled task is enabled or disabled.
</ParamField>

### Response parameters

The API response is returned in a universal and lightweight [JSON format](https://www.json.org/json-en.html).

<ResponseField name="id" type="number">
  Unique identifier for the scheduled task. This ID is automatically generated when you create a new scheduled task.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the scheduled task.
</ResponseField>

<ResponseField name="api" type="string">
  Service to be used for the scheduled task. Available options include `screenshot`, `screencast`, `pdf` and `scrape`.
</ResponseField>

<ResponseField name="query" type="string">
  Query parameters for the scheduled task without the `access_key` parameter.
  The querystring can be URL-encoded.

  For example, `url=https%3A%2F%2Fexample.com` is the URL-encoded version of `url=https://example.com`.
</ResponseField>

<ResponseField name="frequency" type="string">
  Frequency of the scheduled task. Available options are `every_minute`, `every_hour`, `every_day`, `every_month` and `custom` (use standard cron syntax).
</ResponseField>

<ResponseField name="crontab" type="string">
  Cron expression used to the scheduled task. Use [Unix Cron Format](https://crontab-generator.com/en)
</ResponseField>

<ResponseField name="timezone" type="string">
  Timezone for the scheduled task. Available time zones from the [IANA Time Zone Database](https://www.iana.org/time-zones).
</ResponseField>

<ResponseField name="enabled" type="boolean">
  Indicates if the scheduled task is enabled or disabled.
</ResponseField>

<ResponseField name="created" type="number">
  Unix timestamp in seconds when the scheduled task was created.
</ResponseField>

<ResponseField name="last_run" type="number">
  Unix timestamp in seconds when the scheduled task was last run.
</ResponseField>

<ResponseField name="runs" type="number">
  Number of times the scheduled task has run.
</ResponseField>

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                          |
| ---- | --------------------- | ---------------------------------------------------------------- |
| 201  | OK                    | The request was successful.                                      |
| 400  | Bad Request           | The request was rejected due to a missing or invalid parameter.  |
| 401  | Unauthorized          | The request was rejected due to an invalid access key.           |
| 402  | Payment Required      | Access denied due to an unpaid invoice.                          |
| 404  | Not Found             | The requested resource was not found.                            |
| 423  | Locked                | The request was denied due to insufficient quota.                |
| 429  | Too Many Requests     | The rate limit has been exceeded (too many requests per minute). |
| 500  | Internal server error | The request failed due to an internal server error.              |


# Usage
Source: https://docs.screenshotmax.com/endpoints/usage

GET https://api.screenshotmax.com/v1/usage
Get usage statistics for your account.

It’s simple to use: you only need to submit your `access_key`. The API will return the usage statistics for your account.

<Note>Requests to this endpoint are **not counted against your usage quota,** but they are **still subject to rate limiting.** This ensures fair use and stability of the platform. If you exceed the rate limit, your requests may be temporarily blocked.</Note>

## Getting started

### REST

The Usage API, like all of ScreenshotMAX’s APIs, is organized around REST. It is designed to use predictable, resource-oriented URL’s and to use HTTP status codes to indicate errors.

### HTTPS

The Usage API requires all communications to be secured TLS 1.2 or greater.

### API Versions

All of ScreenshotMAX’s APIs are versioned. The Usage API is currently on Version 1.

### Your Access Key

Your access key is your unique authentication key to be used to access ScreenshotMAX APIs.
To authenticate your requests, you will need to append your access key to the base URL as a query parameter for GET requests.
For POST requests, you can include your access key in the request body as a JSON object.
You can also use the `X-Access-Key` header to pass your access key.
You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).

### Base URL

```
https://api.screenshotmax.com/v1/usage
```

### Validation endpoint

ScreenshotMAX’s Usage API simply requires your unique access key. The API will return usage statistics for your account.

```
https://api.screenshotmax.com/v1/usage
? access_key=YOUR_ACCESS_KEY
```

This was a successful request, so the API returned a 200 OK response with the usage statistics for your account.

```json
{
  "hits": {
    "quota": 1000,
    "used": 500,
    "remaining": 500
  },
  "concurrency": {
    "limit": 100,
    "remaining": 50,
    "reset": 1633036868
  }
}
```

### Request parameters

<ParamField query="access_key" type="string" required>
  Your unique access key. You can find your access key in your [account dashboard](https://app.screenshotmax.com/access).
</ParamField>

### Response parameters

The API response is returned in a universal and lightweight [JSON format](https://www.json.org/json-en.html).

<ResponseField name="hits" type="object">
  Usage statistics for your account.

  <Expandable title="properties">
    <ResponseField name="quota" type="number">
      Total number of requests allowed per period.
    </ResponseField>

    <ResponseField name="used" type="number">
      Number of requests used this period.
    </ResponseField>

    <ResponseField name="remaining" type="number">
      Number of requests remaining this period.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="concurrency" type="object">
  Usage statistics for your account.

  <Expandable title="properties">
    <ResponseField name="limit" type="number">
      Total number of concurrent requests allowed.
    </ResponseField>

    <ResponseField name="remaining" type="number">
      Number of concurrent requests remaining.
    </ResponseField>

    <ResponseField name="reset" type="number">
      Unix timestamp in seconds when the concurrency limit resets.
    </ResponseField>
  </Expandable>
</ResponseField>

### Error Codes

Whenever you make a request that fails for some reason, an error is returned also in the JSON format. The errors include an error code and description, which you can find in detail below.

| Code | Type                  | Details                                                |
| ---- | --------------------- | ------------------------------------------------------ |
| 200  | OK                    | The request was successful.                            |
| 401  | Unauthorized          | The request was rejected due to an invalid access key. |
| 500  | Internal server error | The request failed due to an internal server error.    |


# null
Source: https://docs.screenshotmax.com/guides/no-code/bubble





# null
Source: https://docs.screenshotmax.com/guides/no-code/make





# null
Source: https://docs.screenshotmax.com/guides/no-code/zappier





# Devices
Source: https://docs.screenshotmax.com/guides/references/devices

Get a list of available devices for emulation



# HTML to PDF Options
Source: https://docs.screenshotmax.com/guides/references/pdf-options

Customize HTML to PDF generation with ScreenshotMAX API

<Frame caption="Example of https://nytimes.com pdf">
  <iframe src="https://screenshotmax.com/static/media/pdf/nytimes.pdf" height="350" width="100%" />
</Frame>

## Credentials

### access\_key

This parameter is used to authenticate API requests. It should be a string with a maximum length of 24 characters. Every request to the ScreenshotMAX API must include a valid `access_key`, which identifies the calling account. Example: `access_key=abcd1234efgh5678ijkl9012`.

### signature

This parameter is used to verify the authenticity of the request. It should be a string with a maximum length of 64 characters. The `signature` is generated using the `access_key` and your secret key, ensuring that the request has not been tampered with. Example: `signature=abcd1234efgh5678ijkl9012mnop3456`.

## Essential

### url

Defines the target webpage to capture. This parameter must be a valid URL.

You can pass the URL as either a plain string or a percent-encoded string.\
Use encoded format when the URL contains query parameters to avoid conflicts with the API's own querystring.

**Examples:**

* Plain: `url=https://www.example.com`
* Encoded: `url=https%3A%2F%2Fwww.example.com%3Fparam1%3Dvalue1%26param2%3Dvalue2`

### html

This parameter allows you to provide raw HTML content to render and convert to PDF.
It must be a valid HTML string.

**Either `url` or `html` must be provided.**

Example:
`html=<html><body><h1>Hello, World!</h1></body></html>`

### pdf\_paper\_format

This parameter specifies the paper format for the generated PDF.\
It should be a string that matches one of the supported values.

**Default value:** `letter`

Example:\
`paper_format=a4`

Supported values:

| Value   | Description                 | Dimensions (metric) | Dimensions (imperial)    |
| ------- | --------------------------- | ------------------- | ------------------------ |
| a0      | ISO A0 paper size           | 841 × 1189 mm       | 33.1102 × 46.811 inches  |
| a1      | ISO A1 paper size           | 594 × 841 mm        | 23.3858 × 33.1102 inches |
| a2      | ISO A2 paper size           | 420 × 594 mm        | 16.5354 × 23.3858 inches |
| a3      | ISO A3 paper size           | 297 × 420 mm        | 11.6929 × 16.5354 inches |
| a4      | ISO A4 paper size           | 210 × 297 mm        | 8.2677 × 11.6929 inches  |
| a5      | ISO A5 paper size           | 148 × 210 mm        | 5.8268 × 8.2677 inches   |
| a6      | ISO A6 paper size           | 105 × 148 mm        | 4.1339 × 5.8268 inches   |
| legal   | Legal paper size            | 2159 × 3556 mm      | 8.5 × 14 inches          |
| letter  | Letter paper size (default) | 2159 × 2794 mm      | 8.5 × 11 inches          |
| ledger  | Ledger paper size           | 4318 × 2794 mm      | 17 × 11 inches           |
| tabloid | Tabloid paper size          | 2794 × 4318 mm      | 11 × 17 inches           |

### pdf\_print\_background

This parameter indicates whether to print the background graphics in the PDF. It is a boolean value with a default of `false`. When set to `true`, the API will include background graphics in the PDF.

### pdf\_landscape

This parameter indicates whether to print the PDF in landscape mode. It is a boolean value with a default of `false`. When set to `true`, the API will generate the PDF in landscape orientation.

## GPU

### gpu\_rendering

This parameter determines whether to enable GPU rendering for the webpage. It should be a boolean value, with a default of `false`. Enabling GPU rendering can improve the quality of the capture for complex webpages. Example: `gpu_rendering=true`.

## Viewport

This section describes the parameters used to control the viewport settings for captures. These parameters can help simulate different devices and screen sizes.

### capture\_beyond\_viewport

This parameter allows capturing content beyond the viewport. It is a boolean value with a default of `false`. When set to `true`, the API will capture content that is not currently visible in the viewport. Example: `capture_beyond_viewport=true`.

### viewport\_device

This parameter specifies the device type to simulate for the viewport.\
It should be a string that matches one of the supported device names.

Using this parameter allows the API to emulate different screen sizes and behaviors when capturing screenshots.

Example:\
`viewport_device=iphone_13`

The full list of supported devices is available via the `/devices` endpoint.\
[More information →](https://docs.screenshotmax.com/endpoints/devices)

### viewport\_width

This parameter sets the width of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport width can help capture screenshots that match specific screen sizes. Example: `viewport_width=1280`.

### viewport\_height

This parameter sets the height of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport height can help capture screenshots that match specific screen sizes. Example: `viewport_height=720`.

### viewport\_landscape

This parameter specifies whether the viewport should be in landscape mode. It is a boolean value. Setting this to `true` will change the orientation of the viewport. Example: `viewport_landscape=true`.

### viewport\_has\_touch

This parameter indicates whether the viewport has touch capabilities. It is a boolean value. This affects how the page is rendered and can be useful for mobile simulations. Example: `viewport_has_touch=true`.

### viewport\_mobile

This parameter indicates whether the viewport is a mobile device. It is a boolean value. Setting this to `true` will simulate a mobile device environment. Example: `viewport_mobile=true`.

### device\_scale\_factor

This parameter determines the device scale factor for the viewport. It should be a number between 1 and 5. This affects the pixel density of the screen. Example: `device_scale_factor=2`.

## Clip

This section explains the clipping parameters used to define which parts of a webpage are captured.

### clip\_x

This parameter specifies the x-coordinate  of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_x=100`.

### clip\_y

This parameter specifies the y-coordinate of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_y=100`.

### clip\_width

This parameter sets the width of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_width=800`.

### clip\_height

This parameter sets the height of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_height=600`.

## Blocking

This section describes the parameters used to block certain elements or resources during the rendering process of the webpage. These parameters help enhance capture speed and content quality by removing unnecessary elements.

### block\_annoyance

This parameter specifies the type of annoyance to block during the capture.\
It should be a string that matches one of the supported values.

Default value: `cookies_banner`\
Example:\
`block_annoyance=ads`

Supported values:

| Value           | Description                            |
| --------------- | -------------------------------------- |
| none            | No blocking; capture the page as-is    |
| ads             | Block advertisements                   |
| tracking        | Block tracking scripts and pixels      |
| cookies\_banner | Block cookie consent banners (default) |

### block\_ressources

This parameter specifies the types of resources to block during the capture.\
It should be an array of strings that match the supported resource types.

Example:\
`block_ressources=image&block_ressources=stylesheet`

Supported resource types:

| Resource Type | Description                             |
| ------------- | --------------------------------------- |
| document      | Main HTML documents                     |
| stylesheet    | CSS stylesheets                         |
| image         | Images (e.g., JPEG, PNG, SVG)           |
| media         | Audio and video files                   |
| font          | Web fonts                               |
| script        | JavaScript files                        |
| texttrack     | Text tracks for media (e.g., subtitles) |
| xhr           | XMLHttpRequests (AJAX calls)            |
| fetch         | Fetch API requests                      |
| eventsource   | Server-Sent Events (SSE)                |
| websocket     | WebSocket connections                   |
| manifest      | Web app manifests                       |
| other         | Other types not explicitly listed above |

## Emulation

This section describes the parameters used to control the emulation behavior for captures. These parameters can help simulate different environments and conditions for capturing webpages.

### media\_type

This parameter specifies the media type for the webpage. It should be a string that matches either `screen` or `print`, with a default of `screen`. This affects how the page is rendered. Example: `media_type=print`.

### vision\_deficiency

This parameter indicates the type of vision deficiency to simulate.\
It should be a string that matches one of the supported values.

This can help test accessibility and ensure your content is perceivable by users with visual impairments.

Example:\
`vision_deficiency=deuteranopia`

Supported values:

| Value             | Description                            |
| ----------------- | -------------------------------------- |
| achromatopsia     | Complete color blindness               |
| deuteranopia      | Red-green color blindness (green-weak) |
| blurred\_vision   | Simulates blurred vision               |
| reduced\_contrast | Simulates reduced contrast sensitivity |

### dark\_mode

This parameter indicates whether to enable dark mode for the webpage. It is a boolean value with a default of `false`. When set to `true`, the screenshot will render in dark mode. Example: `dark_mode=true`.

### reduced\_motion

This parameter indicates whether to reduce motion effects in the webpage. It is a boolean value with a default of `false`. This can be helpful for accessibility purposes. Example: `reduced_motion=true`.

## Customization

This section describes the parameters used to customize the capture process. These parameters can help tailor the capture to specific needs or preferences.

### hide\_selectors

This parameter specifies selectors to hide during the capture. It should be an array of strings. This can be useful for removing unwanted elements from the content. Example: `hide_selectors=.ad-banner&hide_selectors=.popup`.

### click\_selector

This parameter specifies a selector to click before taking the capture. It should be a string. This allows for interacting with the page before capturing. Example: `click_selector=.start-button`.

## Geolocation

The geolocation parameters allow you to simulate different geographical locations and conditions in your tests. This can be useful for testing location-based features or services.

### geolocation\_accuracy

This parameter sets the accuracy level for geolocation. It must be an integer between 0 and 1,000. This can help simulate different geolocation scenarios. Example: `geolocation_accuracy=200`.

### geolocation\_latitude

This parameter specifies the latitude for geolocation. It must be a number between -90 and 90. This allows for simulating different geographical locations. Example: `geolocation_latitude=37.7749`.

### geolocation\_longitude

This parameter specifies the longitude for geolocation. It must be a number between -180 and 180. This allows for simulating different geographical locations. Example: `geolocation_longitude=-122.4194`.

## Request

This section describes the parameters that can be used in the request to the API.

### timezone

his parameter specifies the time zone for the capture.\
It should be a string that matches one of the supported time zone names.

This helps simulate different local times during the capture process.\
Example:\
`timezone=America/Los_Angeles`

Supported values:

| Timezone                         |
| -------------------------------- |
| Africa/Abidjan                   |
| Africa/Accra                     |
| Africa/Addis\_Ababa              |
| Africa/Algiers                   |
| Africa/Asmara                    |
| Africa/Bamako                    |
| Africa/Bangui                    |
| Africa/Banjul                    |
| Africa/Bissau                    |
| Africa/Blantyre                  |
| Africa/Brazzaville               |
| Africa/Bujumbura                 |
| Africa/Cairo                     |
| Africa/Casablanca                |
| Africa/Ceuta                     |
| Africa/Conakry                   |
| Africa/Dakar                     |
| Africa/Dar\_es\_Salaam           |
| Africa/Djibouti                  |
| Africa/Douala                    |
| Africa/El\_Aaiun                 |
| Africa/Freetown                  |
| Africa/Gaborone                  |
| Africa/Harare                    |
| Africa/Johannesburg              |
| Africa/Juba                      |
| Africa/Kampala                   |
| Africa/Khartoum                  |
| Africa/Kigali                    |
| Africa/Kinshasa                  |
| Africa/Lagos                     |
| Africa/Libreville                |
| Africa/Lome                      |
| Africa/Luanda                    |
| Africa/Lubumbashi                |
| Africa/Lusaka                    |
| Africa/Malabo                    |
| Africa/Maputo                    |
| Africa/Maseru                    |
| Africa/Mbabane                   |
| Africa/Mogadishu                 |
| Africa/Monrovia                  |
| Africa/Nairobi                   |
| Africa/Ndjamena                  |
| Africa/Niamey                    |
| Africa/Nouakchott                |
| Africa/Ouagadougou               |
| Africa/Porto-Novo                |
| Africa/Sao\_Tome                 |
| Africa/Tripoli                   |
| Africa/Tunis                     |
| Africa/Windhoek                  |
| America/Adak                     |
| America/Anchorage                |
| America/Anguilla                 |
| America/Antigua                  |
| America/Araguaina                |
| America/Argentina/Buenos\_Aires  |
| America/Argentina/Catamarca      |
| America/Argentina/Cordoba        |
| America/Argentina/Jujuy          |
| America/Argentina/La\_Rioja      |
| America/Argentina/Mendoza        |
| America/Argentina/Rio\_Gallegos  |
| America/Argentina/Salta          |
| America/Argentina/San\_Juan      |
| America/Argentina/San\_Luis      |
| America/Argentina/Tucuman        |
| America/Argentina/Ushuaia        |
| America/Aruba                    |
| America/Asuncion                 |
| America/Atikokan                 |
| America/Bahia                    |
| America/Bahia\_Banderas          |
| America/Barbados                 |
| America/Belem                    |
| America/Belize                   |
| America/Blanc-Sablon             |
| America/Boa\_Vista               |
| America/Bogota                   |
| America/Boise                    |
| America/Cambridge\_Bay           |
| America/Campo\_Grande            |
| America/Cancun                   |
| America/Caracas                  |
| America/Cayenne                  |
| America/Cayman                   |
| America/Chicago                  |
| America/Chihuahua                |
| America/Ciudad\_Juarez           |
| America/Costa\_Rica              |
| America/Creston                  |
| America/Cuiaba                   |
| America/Curacao                  |
| America/Danmarkshavn             |
| America/Dawson                   |
| America/Dawson\_Creek            |
| America/Denver                   |
| America/Detroit                  |
| America/Dominica                 |
| America/Edmonton                 |
| America/Eirunepe                 |
| America/El\_Salvador             |
| America/Fort\_Nelson             |
| America/Fortaleza                |
| America/Glace\_Bay               |
| America/Goose\_Bay               |
| America/Grand\_Turk              |
| America/Grenada                  |
| America/Guadeloupe               |
| America/Guatemala                |
| America/Guayaquil                |
| America/Guyana                   |
| America/Halifax                  |
| America/Havana                   |
| America/Hermosillo               |
| America/Indiana/Indianapolis     |
| America/Indiana/Knox             |
| America/Indiana/Marengo          |
| America/Indiana/Petersburg       |
| America/Indiana/Tell\_City       |
| America/Indiana/Vevay            |
| America/Indiana/Vincennes        |
| America/Indiana/Winamac          |
| America/Inuvik                   |
| America/Iqaluit                  |
| America/Jamaica                  |
| America/Juneau                   |
| America/Kentucky/Louisville      |
| America/Kentucky/Monticello      |
| America/Kralendijk               |
| America/La\_Paz                  |
| America/Lima                     |
| America/Los\_Angeles             |
| America/Lower\_Princes           |
| America/Maceio                   |
| America/Managua                  |
| America/Manaus                   |
| America/Marigot                  |
| America/Martinique               |
| America/Matamoros                |
| America/Mazatlan                 |
| America/Menominee                |
| America/Merida                   |
| America/Metlakatla               |
| America/Mexico\_City             |
| America/Miquelon                 |
| America/Moncton                  |
| America/Monterrey                |
| America/Montevideo               |
| America/Montserrat               |
| America/Nassau                   |
| America/New\_York                |
| America/Nome                     |
| America/Noronha                  |
| America/North\_Dakota/Beulah     |
| America/North\_Dakota/Center     |
| America/North\_Dakota/New\_Salem |
| America/Nuuk                     |
| America/Ojinaga                  |
| America/Panama                   |
| America/Paramaribo               |
| America/Phoenix                  |
| America/Port-au-Prince           |
| America/Port\_of\_Spain          |
| America/Porto\_Velho             |
| America/Puerto\_Rico             |
| America/Punta\_Arenas            |
| America/Rankin\_Inlet            |
| America/Recife                   |
| America/Regina                   |
| America/Resolute                 |
| America/Rio\_Branco              |
| America/Santarem                 |
| America/Santiago                 |
| America/Santo\_Domingo           |
| America/Sao\_Paulo               |
| America/Scoresbysund             |
| America/Sitka                    |
| America/St\_Barthelemy           |
| America/St\_Johns                |
| America/St\_Kitts                |
| America/St\_Lucia                |
| America/St\_Thomas               |
| America/St\_Vincent              |
| America/Swift\_Current           |
| America/Tegucigalpa              |
| America/Thule                    |
| America/Tijuana                  |
| America/Toronto                  |
| America/Tortola                  |
| America/Vancouver                |
| America/Whitehorse               |
| America/Winnipeg                 |
| America/Yakutat                  |
| America/Yellowknife              |
| Antarctica/Casey                 |
| Antarctica/Davis                 |
| Antarctica/DumontDUrville        |
| Antarctica/Macquarie             |
| Antarctica/Mawson                |
| Antarctica/McMurdo               |
| Antarctica/Palmer                |
| Antarctica/Rothera               |
| Antarctica/Syowa                 |
| Antarctica/Troll                 |
| Antarctica/Vostok                |
| Arctic/Longyearbyen              |
| Asia/Aden                        |
| Asia/Almaty                      |
| Asia/Amman                       |
| Asia/Anadyr                      |
| Asia/Aqtau                       |
| Asia/Aqtobe                      |
| Asia/Ashgabat                    |
| Asia/Atyrau                      |
| Asia/Baghdad                     |
| Asia/Bahrain                     |
| Asia/Baku                        |
| Asia/Bangkok                     |
| Asia/Barnaul                     |
| Asia/Beirut                      |
| Asia/Bishkek                     |
| Asia/Brunei                      |
| Asia/Chita                       |
| Asia/Choibalsan                  |
| Asia/Colombo                     |
| Asia/Damascus                    |
| Asia/Dhaka                       |
| Asia/Dili                        |
| Asia/Dubai                       |
| Asia/Dushanbe                    |
| Asia/Famagusta                   |
| Asia/Gaza                        |
| Asia/Hebron                      |
| Asia/Ho\_Chi\_Minh               |
| Asia/Hong\_Kong                  |
| Asia/Hovd                        |
| Asia/Irkutsk                     |
| Asia/Jakarta                     |
| Asia/Jayapura                    |
| Asia/Jerusalem                   |
| Asia/Kabul                       |
| Asia/Kamchatka                   |
| Asia/Karachi                     |
| Asia/Kathmandu                   |
| Asia/Khandyga                    |
| Asia/Kolkata                     |
| Asia/Krasnoyarsk                 |
| Asia/Kuala\_Lumpur               |
| Asia/Kuching                     |
| Asia/Kuwait                      |
| Asia/Macau                       |
| Asia/Magadan                     |
| Asia/Makassar                    |
| Asia/Manila                      |
| Asia/Muscat                      |
| Asia/Nicosia                     |
| Asia/Novokuznetsk                |
| Asia/Novosibirsk                 |
| Asia/Omsk                        |
| Asia/Oral                        |
| Asia/Phnom\_Penh                 |
| Asia/Pontianak                   |
| Asia/Pyongyang                   |
| Asia/Qatar                       |
| Asia/Qostanay                    |
| Asia/Qyzylorda                   |
| Asia/Riyadh                      |
| Asia/Sakhalin                    |
| Asia/Samarkand                   |
| Asia/Seoul                       |
| Asia/Shanghai                    |
| Asia/Singapore                   |
| Asia/Srednekolymsk               |
| Asia/Taipei                      |
| Asia/Tashkent                    |
| Asia/Tbilisi                     |
| Asia/Tehran                      |
| Asia/Thimphu                     |
| Asia/Tokyo                       |
| Asia/Tomsk                       |
| Asia/Ulaanbaatar                 |
| Asia/Urumqi                      |
| Asia/Ust-Nera                    |
| Asia/Vientiane                   |
| Asia/Vladivostok                 |
| Asia/Yakutsk                     |
| Asia/Yangon                      |
| Asia/Yekaterinburg               |
| Asia/Yerevan                     |
| Atlantic/Azores                  |
| Atlantic/Bermuda                 |
| Atlantic/Canary                  |
| Atlantic/Cape\_Verde             |
| Atlantic/Faroe                   |
| Atlantic/Madeira                 |
| Atlantic/Reykjavik               |
| Atlantic/South\_Georgia          |
| Atlantic/St\_Helena              |
| Atlantic/Stanley                 |
| Australia/Adelaide               |
| Australia/Brisbane               |
| Australia/Broken\_Hill           |
| Australia/Darwin                 |
| Australia/Eucla                  |
| Australia/Hobart                 |
| Australia/Lindeman               |
| Australia/Lord\_Howe             |
| Australia/Melbourne              |
| Australia/Perth                  |
| Australia/Sydney                 |
| Europe/Amsterdam                 |
| Europe/Andorra                   |
| Europe/Astrakhan                 |
| Europe/Athens                    |
| Europe/Belgrade                  |
| Europe/Berlin                    |
| Europe/Bratislava                |
| Europe/Brussels                  |
| Europe/Bucharest                 |
| Europe/Budapest                  |
| Europe/Busingen                  |
| Europe/Chisinau                  |
| Europe/Copenhagen                |
| Europe/Dublin                    |
| Europe/Gibraltar                 |
| Europe/Guernsey                  |
| Europe/Helsinki                  |
| Europe/Isle\_of\_Man             |
| Europe/Istanbul                  |
| Europe/Jersey                    |
| Europe/Kaliningrad               |
| Europe/Kirov                     |
| Europe/Kyiv                      |
| Europe/Lisbon                    |
| Europe/Ljubljana                 |
| Europe/London                    |
| Europe/Luxembourg                |
| Europe/Madrid                    |
| Europe/Malta                     |
| Europe/Mariehamn                 |
| Europe/Minsk                     |
| Europe/Monaco                    |
| Europe/Moscow                    |
| Europe/Oslo                      |
| Europe/Paris                     |
| Europe/Podgorica                 |
| Europe/Prague                    |
| Europe/Riga                      |
| Europe/Rome                      |
| Europe/Samara                    |
| Europe/San\_Marino               |
| Europe/Sarajevo                  |
| Europe/Saratov                   |
| Europe/Simferopol                |
| Europe/Skopje                    |
| Europe/Sofia                     |
| Europe/Stockholm                 |
| Europe/Tallinn                   |
| Europe/Tirane                    |
| Europe/Ulyanovsk                 |
| Europe/Vaduz                     |
| Europe/Vatican                   |
| Europe/Vienna                    |
| Europe/Vilnius                   |
| Europe/Volgograd                 |
| Europe/Warsaw                    |
| Europe/Zagreb                    |
| Europe/Zurich                    |
| Indian/Antananarivo              |
| Indian/Chagos                    |
| Indian/Christmas                 |
| Indian/Cocos                     |
| Indian/Comoro                    |
| Indian/Kerguelen                 |
| Indian/Mahe                      |
| Indian/Maldives                  |
| Indian/Mauritius                 |
| Indian/Mayotte                   |
| Indian/Reunion                   |
| Pacific/Apia                     |
| Pacific/Auckland                 |
| Pacific/Bougainville             |
| Pacific/Chatham                  |
| Pacific/Chuuk                    |
| Pacific/Easter                   |
| Pacific/Efate                    |
| Pacific/Fakaofo                  |
| Pacific/Fiji                     |
| Pacific/Funafuti                 |
| Pacific/Galapagos                |
| Pacific/Gambier                  |
| Pacific/Guadalcanal              |
| Pacific/Guam                     |
| Pacific/Honolulu                 |
| Pacific/Kanton                   |
| Pacific/Kiritimati               |
| Pacific/Kosrae                   |
| Pacific/Kwajalein                |
| Pacific/Majuro                   |
| Pacific/Marquesas                |
| Pacific/Midway                   |
| Pacific/Nauru                    |
| Pacific/Niue                     |
| Pacific/Norfolk                  |
| Pacific/Noumea                   |
| Pacific/Pago\_Pago               |
| Pacific/Palau                    |
| Pacific/Pitcairn                 |
| Pacific/Pohnpei                  |
| Pacific/Port\_Moresby            |
| Pacific/Rarotonga                |
| Pacific/Saipan                   |
| Pacific/Tahiti                   |
| Pacific/Tarawa                   |
| Pacific/Tongatapu                |
| Pacific/Wake                     |
| Pacific/Wallis                   |

### authorization

Specifies the authorization token to include with the API request, typically used to access protected resources.\
This should be a string encoded in Base64 and passed as the value of the `Authorization` header.

**Example:** `authorization=<base64-encoded-token>`

**Note:** Ensure the token is properly encoded to avoid authentication errors. Common formats include Basic Auth (`username:password`) or Bearer tokens, depending on the target service.

### attachment\_name

This parameter specifies the name of the attachment for the result. It should be a string without the extension. The extension will be computed from the response. This can be useful for identifying the screenshot in a list of attachments. Example: `attachment_name=screenshot`.

### user\_agent

This parameter specifies the user agent string to use for the request. It should be a string. This allows for simulating different browsers or devices. Example: `user_agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3`.

### cookies

This parameter allows for specifying cookies to include in the request. It should be an array of strings. This can be useful for maintaining session state. Example: `cookies=session_id=abc123&cookies=user_id=xyz789`.

### headers

This parameter allows for specifying additional headers to include in the request. It should be an array of strings. This can be useful for passing custom headers. Example: `headers=X-Custom-Header:value`.

### ip\_location

This parameter specifies the IP location to simulate. It should be a string that matches one of the supported values.

Example:\
`ip_location=us`

Supported values:

| Country Code | Country                            |
| ------------ | ---------------------------------- |
| us           | United States                      |
| cn           | China                              |
| eu           | European Union (random EU country) |
| ca           | Canada                             |
| mx           | Mexico                             |
| gb           | United Kingdom                     |
| de           | Germany                            |
| fr           | France                             |
| ch           | Switzerland                        |
| in           | India                              |
| jp           | Japan                              |
| kr           | South Korea                        |
| ru           | Russia                             |
| br           | Brazil                             |
| au           | Australia                          |

### bypass\_csp

This parameter indicates whether to bypass Content Security Policy during the capture. It is a boolean value with a default of `false`. This can be useful for testing pages with strict CSP. Example: `bypass_csp=true`.

### proxy

This parameter specifies a proxy server to use for the request. It should be a string in URI format. This can be useful for routing requests through a specific server. Example: `proxy=http://proxy.example.com:8080`.

## Wait

This section describes the parameters that can be used to control the timing of the capture process.

### delay

This parameter sets a delay in seconds before taking the capture. It must be an integer between 0 and 30, with a default of 0. This can help ensure that the page is fully loaded before capturing. Example: `delay=5`.

### timeout

This parameter sets a timeout in seconds for the request. It must be an integer between 0 and 30, with a default of 30. This can help prevent long waits for unresponsive pages. Example: `timeout=10`.

### wait\_until

This parameter specifies the events to wait for before taking the capture.\
It should be an array of strings that match one of the supported events.\
Default is `domcontentloaded`.

Example: `wait_until=load&wait_until=networkidle0`

| Event              | Description                                                                                       |
| ------------------ | ------------------------------------------------------------------------------------------------- |
| `load`             | Waits for the `load` event to fire (all resources including images and scripts).                  |
| `domcontentloaded` | Waits for the DOMContentLoaded event (when the initial HTML document is fully loaded and parsed). |
| `networkidle0`     | Waits until there are no more than 0 network connections for at least 500 ms.                     |
| `networkidle2`     | Waits until there are no more than 2 network connections for at least 500 ms.                     |

## Metadata

The metadata parameters allow you to include additional information in the capture request. This can be useful for debugging, analysis, or simply to provide more context about the captured content.

### metadata\_icon

This parameter indicates whether to include the website's icon (favicon) in the metadata. It is a boolean value with a default of `false`. Example: `metadata_icon=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Icon` — the URL path to the favicon of the target webpage.

### metadata\_fonts

This parameter indicates whether to include font information in the metadata. It is a boolean value with a default of `false`. This can be useful for analyzing the fonts used on the webpage. Example: `metadata_fonts=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Fonts` — a comma-separated list of fonts used on the page.

### metadata\_title

This parameter indicates whether to include the page title in the metadata. It is a boolean value with a default of `false`. Example: `metadata_title=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Title` — the `<title>` of the target webpage.

### metadata\_status

This parameter indicates whether to include the HTTP status in the metadata. It is a boolean value with a default of `false`. This can be useful for understanding the response status of the request. Example: `metadata_status=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Status` — the HTTP status code of the response.

### metadata\_headers

This parameter indicates whether to include the response headers in the metadata. It is a boolean value with a default of `false`. This can help in analyzing the headers returned by the server. Example: `metadata_headers=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Headers` — a JSON string of all response headers from the target webpage.

### metadata\_hash

This parameter indicates whether to include a hash of the captured content in the metadata. It is a boolean value with a default of `false`. Example: `metadata_hash=true`.
If enabled, the response headers will include:  `X-Screenshotmax-Metadata-Hash` — a SHA-256 hash of the webpage content, useful for change detection.

## Caching

This section outlines the parameters available to configure caching behavior for content responses in API requests.
Captured content can be stored in the cache for a specified duration, enabling faster retrieval of previously processed results.
This helps reduce load times and improve performance for frequently accessed content.

Cached content is accessible via a URL in the following format:
[https://cache.screenshotmax.com/\{hash}.\{ext}](https://cache.screenshotmax.com/\{hash}.\{ext})

In the response headers, the key `X-Screenshotmax-Cache-Url` provides the direct URL to the cached version of the content.

### cache

This parameter indicates whether to enable caching for the result. It is a boolean value with a default of `false`. Example: `cache=true`.

### cache\_ttl

This parameter sets the time-to-live for cached result in seconds. It must be an integer between 1 and 2,592,000 (30 days), with a default of 604,800 (7 days). This controls how long cached results are kept. Example: `cache_ttl=86400`.

## Async and Webhook

This section outlines the parameters used for asynchronous processing and webhook notifications in API requests.

### async

This parameter indicates whether the request should be processed asynchronously. It is a boolean value with a default of `false`. This can be useful for handling long-running requests without blocking. Example: `async=true`.

### webhook\_url

This parameter specifies a webhook URL to send notifications to when the request is completed. It should be a string in URI format.
The webhook URL muste support POST requests and be publicly accessible. Example: `webhook_url=https://example.com/webhook`.

### webhook\_signed

This parameter indicates whether the webhook should be signed for security. It is a boolean value with a default of `true`. This can help ensure that notifications are from a trusted source. Example: `webhook_signed=false`.

The signature is a SHA-256 hash of the request body combined with your secret key. It ensures the authenticity of the notification and protects against tampering.
For details on how to verify the signature, refer to the [signed requests documentation](https://docs.screenshotmax.com/guides/start/signed-requests).


# Web Scraping Options
Source: https://docs.screenshotmax.com/guides/references/scrape-options

Customize web scraping with ScreenshotMAX API

<Frame caption="Example of https://news.ycombinator.com scrape">
  ```html
      <html lang="en" op="news"><head><meta name="referrer" content="origin">
      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <link rel="stylesheet" type="text/css" href="news.css?ntgqEkV3OuFpsgWWdX4U">
      <link rel="icon" href="y18.svg">
      <link rel="alternate" type="application/rss+xml" title="RSS" href="rss">
      <title>Hacker News</title></head>
      <body><center><table id="hnmain" border="0" cellpadding="0" cellspacing="0" 
      width="85%" bgcolor="#f6f6ef">
      <tr><td bgcolor="#ff6600"><table border="0" cellpadding="0" cellspacing="0" 
      width="100%" style="padding:2px">
      <tr><td style="width:18px;padding-right:4px">
        <a href="https://news.ycombinator.com">
      <img src="y18.svg" width="18" height="18" 
      style="border:1px white solid; display:block"></a></td>
      <td style="line-height:12pt; height:10px;"><span class="pagetop">
      <b class="hnname"><a href="news">Hacker News</a></b>...
  ```
</Frame>

## Credentials

### access\_key

This parameter is used to authenticate API requests. It should be a string with a maximum length of 24 characters. Every request to the ScreenshotMAX API must include a valid `access_key`, which identifies the calling account. Example: `access_key=abcd1234efgh5678ijkl9012`.

### signature

This parameter is used to verify the authenticity of the request. It should be a string with a maximum length of 64 characters. The `signature` is generated using the `access_key` and your secret key, ensuring that the request has not been tampered with. Example: `signature=abcd1234efgh5678ijkl9012mnop3456`.

## Essential

### url

Defines the target webpage to capture. This parameter must be a valid URL.

You can pass the URL as either a plain string or a percent-encoded string.\
Use encoded format when the URL contains query parameters to avoid conflicts with the API's own querystring.

**Examples:**

* Plain: `url=https://www.example.com`
* Encoded: `url=https%3A%2F%2Fwww.example.com%3Fparam1%3Dvalue1%26param2%3Dvalue2`

### format

This parameter specifies the output format of the scraped content.

**Default value:** `html`

Example:\
`format=md`

Supported values:

| Format | Description                         |
| ------ | ----------------------------------- |
| `html` | Raw HTML content of the page        |
| `md`   | Markdown representation of the page |

### js\_enabled

This parameter indicates whether to enable JavaScript execution on the page. It is a boolean value with a default of `true`. When set to `true`, the API will execute JavaScript on the page before scraping.

## GPU

### gpu\_rendering

This parameter determines whether to enable GPU rendering for the webpage. It should be a boolean value, with a default of `false`. Enabling GPU rendering can improve the quality of the capture for complex webpages. Example: `gpu_rendering=true`.

## Viewport

This section describes the parameters used to control the viewport settings for captures. These parameters can help simulate different devices and screen sizes.

### capture\_beyond\_viewport

This parameter allows capturing content beyond the viewport. It is a boolean value with a default of `false`. When set to `true`, the API will capture content that is not currently visible in the viewport. Example: `capture_beyond_viewport=true`.

### viewport\_device

This parameter specifies the device type to simulate for the viewport.\
It should be a string that matches one of the supported device names.

Using this parameter allows the API to emulate different screen sizes and behaviors when capturing screenshots.

Example:\
`viewport_device=iphone_13`

The full list of supported devices is available via the `/devices` endpoint.\
[More information →](https://docs.screenshotmax.com/endpoints/devices)

### viewport\_width

This parameter sets the width of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport width can help capture screenshots that match specific screen sizes. Example: `viewport_width=1280`.

### viewport\_height

This parameter sets the height of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport height can help capture screenshots that match specific screen sizes. Example: `viewport_height=720`.

### viewport\_landscape

This parameter specifies whether the viewport should be in landscape mode. It is a boolean value. Setting this to `true` will change the orientation of the viewport. Example: `viewport_landscape=true`.

### viewport\_has\_touch

This parameter indicates whether the viewport has touch capabilities. It is a boolean value. This affects how the page is rendered and can be useful for mobile simulations. Example: `viewport_has_touch=true`.

### viewport\_mobile

This parameter indicates whether the viewport is a mobile device. It is a boolean value. Setting this to `true` will simulate a mobile device environment. Example: `viewport_mobile=true`.

### device\_scale\_factor

This parameter determines the device scale factor for the viewport. It should be a number between 1 and 5. This affects the pixel density of the screen. Example: `device_scale_factor=2`.

## Blocking

This section describes the parameters used to block certain elements or resources during the rendering process of the webpage. These parameters help enhance capture speed and content quality by removing unnecessary elements.

### block\_annoyance

This parameter specifies the type of annoyance to block during the capture.\
It should be a string that matches one of the supported values.

Default value: `cookies_banner`\
Example:\
`block_annoyance=ads`

Supported values:

| Value           | Description                            |
| --------------- | -------------------------------------- |
| none            | No blocking; capture the page as-is    |
| ads             | Block advertisements                   |
| tracking        | Block tracking scripts and pixels      |
| cookies\_banner | Block cookie consent banners (default) |

### block\_ressources

This parameter specifies the types of resources to block during the capture.\
It should be an array of strings that match the supported resource types.

Example:\
`block_ressources=image&block_ressources=stylesheet`

Supported resource types:

| Resource Type | Description                             |
| ------------- | --------------------------------------- |
| document      | Main HTML documents                     |
| stylesheet    | CSS stylesheets                         |
| image         | Images (e.g., JPEG, PNG, SVG)           |
| media         | Audio and video files                   |
| font          | Web fonts                               |
| script        | JavaScript files                        |
| texttrack     | Text tracks for media (e.g., subtitles) |
| xhr           | XMLHttpRequests (AJAX calls)            |
| fetch         | Fetch API requests                      |
| eventsource   | Server-Sent Events (SSE)                |
| websocket     | WebSocket connections                   |
| manifest      | Web app manifests                       |
| other         | Other types not explicitly listed above |

Use the `block_resources` option **to optimize scraping performance by preventing the loading of non-essential assets** such as images, fonts, and third-party scripts.
Blocking these resources reduces page load time, lowers bandwidth usage, and speeds up the overall scraping process—especially on media-heavy sites.

## Emulation

This section describes the parameters used to control the emulation behavior for captures. These parameters can help simulate different environments and conditions for capturing webpages.

### media\_type

This parameter specifies the media type for the webpage. It should be a string that matches either `screen` or `print`, with a default of `screen`. This affects how the page is rendered. Example: `media_type=print`.

## Customization

This section describes the parameters used to customize the capture process. These parameters can help tailor the capture to specific needs or preferences.

### hide\_selectors

This parameter specifies selectors to hide during the capture. It should be an array of strings. This can be useful for removing unwanted elements from the content. Example: `hide_selectors=.ad-banner&hide_selectors=.popup`.

### click\_selector

This parameter specifies a selector to click before taking the capture. It should be a string. This allows for interacting with the page before capturing. Example: `click_selector=.start-button`.

## Geolocation

The geolocation parameters allow you to simulate different geographical locations and conditions in your tests. This can be useful for testing location-based features or services.

### geolocation\_accuracy

This parameter sets the accuracy level for geolocation. It must be an integer between 0 and 1,000. This can help simulate different geolocation scenarios. Example: `geolocation_accuracy=200`.

### geolocation\_latitude

This parameter specifies the latitude for geolocation. It must be a number between -90 and 90. This allows for simulating different geographical locations. Example: `geolocation_latitude=37.7749`.

### geolocation\_longitude

This parameter specifies the longitude for geolocation. It must be a number between -180 and 180. This allows for simulating different geographical locations. Example: `geolocation_longitude=-122.4194`.

## Request

This section describes the parameters that can be used in the request to the API.

### timezone

his parameter specifies the time zone for the capture.\
It should be a string that matches one of the supported time zone names.

This helps simulate different local times during the capture process.\
Example:\
`timezone=America/Los_Angeles`

Supported values:

| Timezone                         |
| -------------------------------- |
| Africa/Abidjan                   |
| Africa/Accra                     |
| Africa/Addis\_Ababa              |
| Africa/Algiers                   |
| Africa/Asmara                    |
| Africa/Bamako                    |
| Africa/Bangui                    |
| Africa/Banjul                    |
| Africa/Bissau                    |
| Africa/Blantyre                  |
| Africa/Brazzaville               |
| Africa/Bujumbura                 |
| Africa/Cairo                     |
| Africa/Casablanca                |
| Africa/Ceuta                     |
| Africa/Conakry                   |
| Africa/Dakar                     |
| Africa/Dar\_es\_Salaam           |
| Africa/Djibouti                  |
| Africa/Douala                    |
| Africa/El\_Aaiun                 |
| Africa/Freetown                  |
| Africa/Gaborone                  |
| Africa/Harare                    |
| Africa/Johannesburg              |
| Africa/Juba                      |
| Africa/Kampala                   |
| Africa/Khartoum                  |
| Africa/Kigali                    |
| Africa/Kinshasa                  |
| Africa/Lagos                     |
| Africa/Libreville                |
| Africa/Lome                      |
| Africa/Luanda                    |
| Africa/Lubumbashi                |
| Africa/Lusaka                    |
| Africa/Malabo                    |
| Africa/Maputo                    |
| Africa/Maseru                    |
| Africa/Mbabane                   |
| Africa/Mogadishu                 |
| Africa/Monrovia                  |
| Africa/Nairobi                   |
| Africa/Ndjamena                  |
| Africa/Niamey                    |
| Africa/Nouakchott                |
| Africa/Ouagadougou               |
| Africa/Porto-Novo                |
| Africa/Sao\_Tome                 |
| Africa/Tripoli                   |
| Africa/Tunis                     |
| Africa/Windhoek                  |
| America/Adak                     |
| America/Anchorage                |
| America/Anguilla                 |
| America/Antigua                  |
| America/Araguaina                |
| America/Argentina/Buenos\_Aires  |
| America/Argentina/Catamarca      |
| America/Argentina/Cordoba        |
| America/Argentina/Jujuy          |
| America/Argentina/La\_Rioja      |
| America/Argentina/Mendoza        |
| America/Argentina/Rio\_Gallegos  |
| America/Argentina/Salta          |
| America/Argentina/San\_Juan      |
| America/Argentina/San\_Luis      |
| America/Argentina/Tucuman        |
| America/Argentina/Ushuaia        |
| America/Aruba                    |
| America/Asuncion                 |
| America/Atikokan                 |
| America/Bahia                    |
| America/Bahia\_Banderas          |
| America/Barbados                 |
| America/Belem                    |
| America/Belize                   |
| America/Blanc-Sablon             |
| America/Boa\_Vista               |
| America/Bogota                   |
| America/Boise                    |
| America/Cambridge\_Bay           |
| America/Campo\_Grande            |
| America/Cancun                   |
| America/Caracas                  |
| America/Cayenne                  |
| America/Cayman                   |
| America/Chicago                  |
| America/Chihuahua                |
| America/Ciudad\_Juarez           |
| America/Costa\_Rica              |
| America/Creston                  |
| America/Cuiaba                   |
| America/Curacao                  |
| America/Danmarkshavn             |
| America/Dawson                   |
| America/Dawson\_Creek            |
| America/Denver                   |
| America/Detroit                  |
| America/Dominica                 |
| America/Edmonton                 |
| America/Eirunepe                 |
| America/El\_Salvador             |
| America/Fort\_Nelson             |
| America/Fortaleza                |
| America/Glace\_Bay               |
| America/Goose\_Bay               |
| America/Grand\_Turk              |
| America/Grenada                  |
| America/Guadeloupe               |
| America/Guatemala                |
| America/Guayaquil                |
| America/Guyana                   |
| America/Halifax                  |
| America/Havana                   |
| America/Hermosillo               |
| America/Indiana/Indianapolis     |
| America/Indiana/Knox             |
| America/Indiana/Marengo          |
| America/Indiana/Petersburg       |
| America/Indiana/Tell\_City       |
| America/Indiana/Vevay            |
| America/Indiana/Vincennes        |
| America/Indiana/Winamac          |
| America/Inuvik                   |
| America/Iqaluit                  |
| America/Jamaica                  |
| America/Juneau                   |
| America/Kentucky/Louisville      |
| America/Kentucky/Monticello      |
| America/Kralendijk               |
| America/La\_Paz                  |
| America/Lima                     |
| America/Los\_Angeles             |
| America/Lower\_Princes           |
| America/Maceio                   |
| America/Managua                  |
| America/Manaus                   |
| America/Marigot                  |
| America/Martinique               |
| America/Matamoros                |
| America/Mazatlan                 |
| America/Menominee                |
| America/Merida                   |
| America/Metlakatla               |
| America/Mexico\_City             |
| America/Miquelon                 |
| America/Moncton                  |
| America/Monterrey                |
| America/Montevideo               |
| America/Montserrat               |
| America/Nassau                   |
| America/New\_York                |
| America/Nome                     |
| America/Noronha                  |
| America/North\_Dakota/Beulah     |
| America/North\_Dakota/Center     |
| America/North\_Dakota/New\_Salem |
| America/Nuuk                     |
| America/Ojinaga                  |
| America/Panama                   |
| America/Paramaribo               |
| America/Phoenix                  |
| America/Port-au-Prince           |
| America/Port\_of\_Spain          |
| America/Porto\_Velho             |
| America/Puerto\_Rico             |
| America/Punta\_Arenas            |
| America/Rankin\_Inlet            |
| America/Recife                   |
| America/Regina                   |
| America/Resolute                 |
| America/Rio\_Branco              |
| America/Santarem                 |
| America/Santiago                 |
| America/Santo\_Domingo           |
| America/Sao\_Paulo               |
| America/Scoresbysund             |
| America/Sitka                    |
| America/St\_Barthelemy           |
| America/St\_Johns                |
| America/St\_Kitts                |
| America/St\_Lucia                |
| America/St\_Thomas               |
| America/St\_Vincent              |
| America/Swift\_Current           |
| America/Tegucigalpa              |
| America/Thule                    |
| America/Tijuana                  |
| America/Toronto                  |
| America/Tortola                  |
| America/Vancouver                |
| America/Whitehorse               |
| America/Winnipeg                 |
| America/Yakutat                  |
| America/Yellowknife              |
| Antarctica/Casey                 |
| Antarctica/Davis                 |
| Antarctica/DumontDUrville        |
| Antarctica/Macquarie             |
| Antarctica/Mawson                |
| Antarctica/McMurdo               |
| Antarctica/Palmer                |
| Antarctica/Rothera               |
| Antarctica/Syowa                 |
| Antarctica/Troll                 |
| Antarctica/Vostok                |
| Arctic/Longyearbyen              |
| Asia/Aden                        |
| Asia/Almaty                      |
| Asia/Amman                       |
| Asia/Anadyr                      |
| Asia/Aqtau                       |
| Asia/Aqtobe                      |
| Asia/Ashgabat                    |
| Asia/Atyrau                      |
| Asia/Baghdad                     |
| Asia/Bahrain                     |
| Asia/Baku                        |
| Asia/Bangkok                     |
| Asia/Barnaul                     |
| Asia/Beirut                      |
| Asia/Bishkek                     |
| Asia/Brunei                      |
| Asia/Chita                       |
| Asia/Choibalsan                  |
| Asia/Colombo                     |
| Asia/Damascus                    |
| Asia/Dhaka                       |
| Asia/Dili                        |
| Asia/Dubai                       |
| Asia/Dushanbe                    |
| Asia/Famagusta                   |
| Asia/Gaza                        |
| Asia/Hebron                      |
| Asia/Ho\_Chi\_Minh               |
| Asia/Hong\_Kong                  |
| Asia/Hovd                        |
| Asia/Irkutsk                     |
| Asia/Jakarta                     |
| Asia/Jayapura                    |
| Asia/Jerusalem                   |
| Asia/Kabul                       |
| Asia/Kamchatka                   |
| Asia/Karachi                     |
| Asia/Kathmandu                   |
| Asia/Khandyga                    |
| Asia/Kolkata                     |
| Asia/Krasnoyarsk                 |
| Asia/Kuala\_Lumpur               |
| Asia/Kuching                     |
| Asia/Kuwait                      |
| Asia/Macau                       |
| Asia/Magadan                     |
| Asia/Makassar                    |
| Asia/Manila                      |
| Asia/Muscat                      |
| Asia/Nicosia                     |
| Asia/Novokuznetsk                |
| Asia/Novosibirsk                 |
| Asia/Omsk                        |
| Asia/Oral                        |
| Asia/Phnom\_Penh                 |
| Asia/Pontianak                   |
| Asia/Pyongyang                   |
| Asia/Qatar                       |
| Asia/Qostanay                    |
| Asia/Qyzylorda                   |
| Asia/Riyadh                      |
| Asia/Sakhalin                    |
| Asia/Samarkand                   |
| Asia/Seoul                       |
| Asia/Shanghai                    |
| Asia/Singapore                   |
| Asia/Srednekolymsk               |
| Asia/Taipei                      |
| Asia/Tashkent                    |
| Asia/Tbilisi                     |
| Asia/Tehran                      |
| Asia/Thimphu                     |
| Asia/Tokyo                       |
| Asia/Tomsk                       |
| Asia/Ulaanbaatar                 |
| Asia/Urumqi                      |
| Asia/Ust-Nera                    |
| Asia/Vientiane                   |
| Asia/Vladivostok                 |
| Asia/Yakutsk                     |
| Asia/Yangon                      |
| Asia/Yekaterinburg               |
| Asia/Yerevan                     |
| Atlantic/Azores                  |
| Atlantic/Bermuda                 |
| Atlantic/Canary                  |
| Atlantic/Cape\_Verde             |
| Atlantic/Faroe                   |
| Atlantic/Madeira                 |
| Atlantic/Reykjavik               |
| Atlantic/South\_Georgia          |
| Atlantic/St\_Helena              |
| Atlantic/Stanley                 |
| Australia/Adelaide               |
| Australia/Brisbane               |
| Australia/Broken\_Hill           |
| Australia/Darwin                 |
| Australia/Eucla                  |
| Australia/Hobart                 |
| Australia/Lindeman               |
| Australia/Lord\_Howe             |
| Australia/Melbourne              |
| Australia/Perth                  |
| Australia/Sydney                 |
| Europe/Amsterdam                 |
| Europe/Andorra                   |
| Europe/Astrakhan                 |
| Europe/Athens                    |
| Europe/Belgrade                  |
| Europe/Berlin                    |
| Europe/Bratislava                |
| Europe/Brussels                  |
| Europe/Bucharest                 |
| Europe/Budapest                  |
| Europe/Busingen                  |
| Europe/Chisinau                  |
| Europe/Copenhagen                |
| Europe/Dublin                    |
| Europe/Gibraltar                 |
| Europe/Guernsey                  |
| Europe/Helsinki                  |
| Europe/Isle\_of\_Man             |
| Europe/Istanbul                  |
| Europe/Jersey                    |
| Europe/Kaliningrad               |
| Europe/Kirov                     |
| Europe/Kyiv                      |
| Europe/Lisbon                    |
| Europe/Ljubljana                 |
| Europe/London                    |
| Europe/Luxembourg                |
| Europe/Madrid                    |
| Europe/Malta                     |
| Europe/Mariehamn                 |
| Europe/Minsk                     |
| Europe/Monaco                    |
| Europe/Moscow                    |
| Europe/Oslo                      |
| Europe/Paris                     |
| Europe/Podgorica                 |
| Europe/Prague                    |
| Europe/Riga                      |
| Europe/Rome                      |
| Europe/Samara                    |
| Europe/San\_Marino               |
| Europe/Sarajevo                  |
| Europe/Saratov                   |
| Europe/Simferopol                |
| Europe/Skopje                    |
| Europe/Sofia                     |
| Europe/Stockholm                 |
| Europe/Tallinn                   |
| Europe/Tirane                    |
| Europe/Ulyanovsk                 |
| Europe/Vaduz                     |
| Europe/Vatican                   |
| Europe/Vienna                    |
| Europe/Vilnius                   |
| Europe/Volgograd                 |
| Europe/Warsaw                    |
| Europe/Zagreb                    |
| Europe/Zurich                    |
| Indian/Antananarivo              |
| Indian/Chagos                    |
| Indian/Christmas                 |
| Indian/Cocos                     |
| Indian/Comoro                    |
| Indian/Kerguelen                 |
| Indian/Mahe                      |
| Indian/Maldives                  |
| Indian/Mauritius                 |
| Indian/Mayotte                   |
| Indian/Reunion                   |
| Pacific/Apia                     |
| Pacific/Auckland                 |
| Pacific/Bougainville             |
| Pacific/Chatham                  |
| Pacific/Chuuk                    |
| Pacific/Easter                   |
| Pacific/Efate                    |
| Pacific/Fakaofo                  |
| Pacific/Fiji                     |
| Pacific/Funafuti                 |
| Pacific/Galapagos                |
| Pacific/Gambier                  |
| Pacific/Guadalcanal              |
| Pacific/Guam                     |
| Pacific/Honolulu                 |
| Pacific/Kanton                   |
| Pacific/Kiritimati               |
| Pacific/Kosrae                   |
| Pacific/Kwajalein                |
| Pacific/Majuro                   |
| Pacific/Marquesas                |
| Pacific/Midway                   |
| Pacific/Nauru                    |
| Pacific/Niue                     |
| Pacific/Norfolk                  |
| Pacific/Noumea                   |
| Pacific/Pago\_Pago               |
| Pacific/Palau                    |
| Pacific/Pitcairn                 |
| Pacific/Pohnpei                  |
| Pacific/Port\_Moresby            |
| Pacific/Rarotonga                |
| Pacific/Saipan                   |
| Pacific/Tahiti                   |
| Pacific/Tarawa                   |
| Pacific/Tongatapu                |
| Pacific/Wake                     |
| Pacific/Wallis                   |

### authorization

Specifies the authorization token to include with the API request, typically used to access protected resources.\
This should be a string encoded in Base64 and passed as the value of the `Authorization` header.

**Example:** `authorization=<base64-encoded-token>`

**Note:** Ensure the token is properly encoded to avoid authentication errors. Common formats include Basic Auth (`username:password`) or Bearer tokens, depending on the target service.

### attachment\_name

This parameter specifies the name of the attachment for the result. It should be a string without the extension. The extension will be computed from the response. This can be useful for identifying the screenshot in a list of attachments. Example: `attachment_name=screenshot`.

### user\_agent

This parameter specifies the user agent string to use for the request. It should be a string. This allows for simulating different browsers or devices. Example: `user_agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3`.

### cookies

This parameter allows for specifying cookies to include in the request. It should be an array of strings. This can be useful for maintaining session state. Example: `cookies=session_id=abc123&cookies=user_id=xyz789`.

### headers

This parameter allows for specifying additional headers to include in the request. It should be an array of strings. This can be useful for passing custom headers. Example: `headers=X-Custom-Header:value`.

### ip\_location

This parameter specifies the IP location to simulate. It should be a string that matches one of the supported values.

Example:\
`ip_location=us`

Supported values:

| Country Code | Country                            |
| ------------ | ---------------------------------- |
| us           | United States                      |
| cn           | China                              |
| eu           | European Union (random EU country) |
| ca           | Canada                             |
| mx           | Mexico                             |
| gb           | United Kingdom                     |
| de           | Germany                            |
| fr           | France                             |
| ch           | Switzerland                        |
| in           | India                              |
| jp           | Japan                              |
| kr           | South Korea                        |
| ru           | Russia                             |
| br           | Brazil                             |
| au           | Australia                          |

### bypass\_csp

This parameter indicates whether to bypass Content Security Policy during the capture. It is a boolean value with a default of `false`. This can be useful for testing pages with strict CSP. Example: `bypass_csp=true`.

### proxy

This parameter specifies a proxy server to use for the request. It should be a string in URI format. This can be useful for routing requests through a specific server. Example: `proxy=http://proxy.example.com:8080`.

## Wait

This section describes the parameters that can be used to control the timing of the capture process.

### delay

This parameter sets a delay in seconds before taking the capture. It must be an integer between 0 and 30, with a default of 0. This can help ensure that the page is fully loaded before capturing. Example: `delay=5`.

### timeout

This parameter sets a timeout in seconds for the request. It must be an integer between 0 and 30, with a default of 30. This can help prevent long waits for unresponsive pages. Example: `timeout=10`.

### wait\_until

This parameter specifies the events to wait for before taking the capture.\
It should be an array of strings that match one of the supported events.\
Default is `domcontentloaded`.

Example: `wait_until=load&wait_until=networkidle0`

| Event              | Description                                                                                       |
| ------------------ | ------------------------------------------------------------------------------------------------- |
| `load`             | Waits for the `load` event to fire (all resources including images and scripts).                  |
| `domcontentloaded` | Waits for the DOMContentLoaded event (when the initial HTML document is fully loaded and parsed). |
| `networkidle0`     | Waits until there are no more than 0 network connections for at least 500 ms.                     |
| `networkidle2`     | Waits until there are no more than 2 network connections for at least 500 ms.                     |

## Metadata

The metadata parameters allow you to include additional information in the capture request. This can be useful for debugging, analysis, or simply to provide more context about the captured content.

### metadata\_icon

This parameter indicates whether to include the website's icon (favicon) in the metadata. It is a boolean value with a default of `false`. Example: `metadata_icon=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Icon` — the URL path to the favicon of the target webpage.

### metadata\_fonts

This parameter indicates whether to include font information in the metadata. It is a boolean value with a default of `false`. This can be useful for analyzing the fonts used on the webpage. Example: `metadata_fonts=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Fonts` — a comma-separated list of fonts used on the page.

### metadata\_title

This parameter indicates whether to include the page title in the metadata. It is a boolean value with a default of `false`. Example: `metadata_title=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Title` — the `<title>` of the target webpage.

### metadata\_status

This parameter indicates whether to include the HTTP status in the metadata. It is a boolean value with a default of `false`. This can be useful for understanding the response status of the request. Example: `metadata_status=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Status` — the HTTP status code of the response.

### metadata\_headers

This parameter indicates whether to include the response headers in the metadata. It is a boolean value with a default of `false`. This can help in analyzing the headers returned by the server. Example: `metadata_headers=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Headers` — a JSON string of all response headers from the target webpage.

### metadata\_hash

This parameter indicates whether to include a hash of the captured content in the metadata. It is a boolean value with a default of `false`. Example: `metadata_hash=true`.
If enabled, the response headers will include:  `X-Screenshotmax-Metadata-Hash` — a SHA-256 hash of the webpage content, useful for change detection.

## Caching

This section outlines the parameters available to configure caching behavior for content responses in API requests.
Captured content can be stored in the cache for a specified duration, enabling faster retrieval of previously processed results.
This helps reduce load times and improve performance for frequently accessed content.

Cached content is accessible via a URL in the following format:
[https://cache.screenshotmax.com/\{hash}.\{ext}](https://cache.screenshotmax.com/\{hash}.\{ext})

In the response headers, the key `X-Screenshotmax-Cache-Url` provides the direct URL to the cached version of the content.

### cache

This parameter indicates whether to enable caching for the result. It is a boolean value with a default of `false`. Example: `cache=true`.

### cache\_ttl

This parameter sets the time-to-live for cached result in seconds. It must be an integer between 1 and 2,592,000 (30 days), with a default of 604,800 (7 days). This controls how long cached results are kept. Example: `cache_ttl=86400`.

## Async and Webhook

This section outlines the parameters used for asynchronous processing and webhook notifications in API requests.

### async

This parameter indicates whether the request should be processed asynchronously. It is a boolean value with a default of `false`. This can be useful for handling long-running requests without blocking. Example: `async=true`.

### webhook\_url

This parameter specifies a webhook URL to send notifications to when the request is completed. It should be a string in URI format.
The webhook URL muste support POST requests and be publicly accessible. Example: `webhook_url=https://example.com/webhook`.

### webhook\_signed

This parameter indicates whether the webhook should be signed for security. It is a boolean value with a default of `true`. This can help ensure that notifications are from a trusted source. Example: `webhook_signed=false`.

The signature is a SHA-256 hash of the request body combined with your secret key. It ensures the authenticity of the notification and protects against tampering.
For details on how to verify the signature, refer to the [signed requests documentation](https://docs.screenshotmax.com/guides/start/signed-requests).


# Animated Screenshot Options
Source: https://docs.screenshotmax.com/guides/references/screencast-options

Customize animated screenshot generation with ScreenshotMAX API

<Frame caption="Example of https://www.apple.com/apple-watch-ultra-2 animated screenshot">
  <video loop autoPlay muted playsInline src="https://screenshotmax.com/static/media/screencasts/apple-ultra-2-scroll.webm" className="w-full aspect-video" />
</Frame>

## Animated Screenshots Options

The Screencast API offers a range of options to customize how animated screenshots are generated.
You can control various aspects of the recording, such as the format, duration, scrolling behavior, and more.
For a complete overview, visit the [Animated Screenshots guide](https://docs.screenshotmax.com/guides/start/animated-screenshots).

## Credentials

### access\_key

This parameter is used to authenticate API requests. It should be a string with a maximum length of 24 characters. Every request to the ScreenshotMAX API must include a valid `access_key`, which identifies the calling account. Example: `access_key=abcd1234efgh5678ijkl9012`.

### signature

This parameter is used to verify the authenticity of the request. It should be a string with a maximum length of 64 characters. The `signature` is generated using the `access_key` and your secret key, ensuring that the request has not been tampered with. Example: `signature=abcd1234efgh5678ijkl9012mnop3456`.

## Essential

### url

Defines the target webpage to capture. This parameter must be a valid URL.

You can pass the URL as either a plain string or a percent-encoded string.\
Use encoded format when the URL contains query parameters to avoid conflicts with the API's own querystring.

**Examples:**

* Plain: `url=https://www.example.com`
* Encoded: `url=https%3A%2F%2Fwww.example.com%3Fparam1%3Dvalue1%26param2%3Dvalue2`

### format

This parameter specifies the output format of the animated screenshot video.\
It should be a string that matches one of the supported values.

**Default value:** `mp4`

Example:\
`format=webm`

Supported values:

| Value | Description                |
| ----- | -------------------------- |
| webm  | WebM video format          |
| mp4   | MP4 video format (default) |
| mov   | QuickTime MOV format       |
| avi   | AVI video format           |

### duration

This parameter specifies the duration of the animated screenshot in seconds. It is an integer value between `1` and `30`, with a default value of `5`. Example: `duration=10`.

### scenario

This parameter specifies the scenario for the animated screenshot. It can be either `video` or `scroll`. The default value is `video`. Example: `scenario=scroll`.

### scroll\_by\_amount

This parameter specifies the amount to scroll the page when capturing a full-page screenshot. It is an integer value that represents the number of pixels to scroll. The default value is `1000`.

### scroll\_by\_delay

This parameter specifies the delay between scroll actions in milliseconds. It is an integer value that represents the time to wait before scrolling again. The default value is `500`.

### scroll\_by\_duration

This parameter specifies the duration of the scroll when capturing a full-page screenshot. It is an integer value that represents the time in milliseconds to wait before scrolling again. The default value is `1500`.

### scroll\_back

This parameter indicates whether to scroll back to the top of the page after capturing the animated screenshot. It is a boolean value with a default of `true`. When set to `true`, the API scrolls back to the top of the page after capturing the screenshot.

### scroll\_back\_delay

This parameter specifies the delay before scrolling back to the top of the page in milliseconds. It is an integer value that represents the time to wait before scrolling back. The default value is `800`.

### scroll\_easing

This parameter specifies the easing function to use for the scroll animation.\
It should be a string that matches one of the supported values.

**Default value:** `linear`\
Example:\
`scroll_easing="ease_in_out_cubic"`

Supported values:

| Value                | Description                          |
| -------------------- | ------------------------------------ |
| linear               | Constant scroll speed (default)      |
| ease\_in\_quad       | Accelerates from zero velocity       |
| ease\_out\_quad      | Decelerates to zero velocity         |
| ease\_in\_out\_quad  | Accelerates, then decelerates        |
| ease\_in\_cubic      | Stronger acceleration at the start   |
| ease\_out\_cubic     | Stronger deceleration at the end     |
| ease\_in\_out\_cubic | Smooth acceleration and deceleration |
| ease\_in\_quart      | Even stronger start acceleration     |
| ease\_out\_quart     | Even stronger end deceleration       |
| ease\_in\_out\_quart | Balanced quartic easing              |
| ease\_in\_quint      | Fastest acceleration at the start    |
| ease\_out\_quint     | Fastest deceleration at the end      |
| ease\_in\_out\_quint | Fast acceleration and deceleration   |

## GPU

### gpu\_rendering

This parameter determines whether to enable GPU rendering for the webpage. It should be a boolean value, with a default of `false`. Enabling GPU rendering can improve the quality of the capture for complex webpages. Example: `gpu_rendering=true`.

## Viewport

This section describes the parameters used to control the viewport settings for captures. These parameters can help simulate different devices and screen sizes.

### capture\_beyond\_viewport

This parameter allows capturing content beyond the viewport. It is a boolean value with a default of `false`. When set to `true`, the API will capture content that is not currently visible in the viewport. Example: `capture_beyond_viewport=true`.

### viewport\_device

This parameter specifies the device type to simulate for the viewport.\
It should be a string that matches one of the supported device names.

Using this parameter allows the API to emulate different screen sizes and behaviors when capturing screenshots.

Example:\
`viewport_device=iphone_13`

The full list of supported devices is available via the `/devices` endpoint.\
[More information →](https://docs.screenshotmax.com/endpoints/devices)

### viewport\_width

This parameter sets the width of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport width can help capture screenshots that match specific screen sizes. Example: `viewport_width=1280`.

### viewport\_height

This parameter sets the height of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport height can help capture screenshots that match specific screen sizes. Example: `viewport_height=720`.

### viewport\_landscape

This parameter specifies whether the viewport should be in landscape mode. It is a boolean value. Setting this to `true` will change the orientation of the viewport. Example: `viewport_landscape=true`.

### viewport\_has\_touch

This parameter indicates whether the viewport has touch capabilities. It is a boolean value. This affects how the page is rendered and can be useful for mobile simulations. Example: `viewport_has_touch=true`.

### viewport\_mobile

This parameter indicates whether the viewport is a mobile device. It is a boolean value. Setting this to `true` will simulate a mobile device environment. Example: `viewport_mobile=true`.

### device\_scale\_factor

This parameter determines the device scale factor for the viewport. It should be a number between 1 and 5. This affects the pixel density of the screen. Example: `device_scale_factor=2`.

## Clip

This section explains the clipping parameters used to define which parts of a webpage are captured.

### clip\_x

This parameter specifies the x-coordinate  of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_x=100`.

### clip\_y

This parameter specifies the y-coordinate of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_y=100`.

### clip\_width

This parameter sets the width of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_width=800`.

### clip\_height

This parameter sets the height of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_height=600`.

## Blocking

This section describes the parameters used to block certain elements or resources during the rendering process of the webpage. These parameters help enhance capture speed and content quality by removing unnecessary elements.

### block\_annoyance

This parameter specifies the type of annoyance to block during the capture.\
It should be a string that matches one of the supported values.

Default value: `cookies_banner`\
Example:\
`block_annoyance=ads`

Supported values:

| Value           | Description                            |
| --------------- | -------------------------------------- |
| none            | No blocking; capture the page as-is    |
| ads             | Block advertisements                   |
| tracking        | Block tracking scripts and pixels      |
| cookies\_banner | Block cookie consent banners (default) |

### block\_ressources

This parameter specifies the types of resources to block during the capture.\
It should be an array of strings that match the supported resource types.

Example:\
`block_ressources=image&block_ressources=stylesheet`

Supported resource types:

| Resource Type | Description                             |
| ------------- | --------------------------------------- |
| document      | Main HTML documents                     |
| stylesheet    | CSS stylesheets                         |
| image         | Images (e.g., JPEG, PNG, SVG)           |
| media         | Audio and video files                   |
| font          | Web fonts                               |
| script        | JavaScript files                        |
| texttrack     | Text tracks for media (e.g., subtitles) |
| xhr           | XMLHttpRequests (AJAX calls)            |
| fetch         | Fetch API requests                      |
| eventsource   | Server-Sent Events (SSE)                |
| websocket     | WebSocket connections                   |
| manifest      | Web app manifests                       |
| other         | Other types not explicitly listed above |

## Emulation

This section describes the parameters used to control the emulation behavior for captures. These parameters can help simulate different environments and conditions for capturing webpages.

### media\_type

This parameter specifies the media type for the webpage. It should be a string that matches either `screen` or `print`, with a default of `screen`. This affects how the page is rendered. Example: `media_type=print`.

### vision\_deficiency

This parameter indicates the type of vision deficiency to simulate.\
It should be a string that matches one of the supported values.

This can help test accessibility and ensure your content is perceivable by users with visual impairments.

Example:\
`vision_deficiency=deuteranopia`

Supported values:

| Value             | Description                            |
| ----------------- | -------------------------------------- |
| achromatopsia     | Complete color blindness               |
| deuteranopia      | Red-green color blindness (green-weak) |
| blurred\_vision   | Simulates blurred vision               |
| reduced\_contrast | Simulates reduced contrast sensitivity |

### dark\_mode

This parameter indicates whether to enable dark mode for the webpage. It is a boolean value with a default of `false`. When set to `true`, the screenshot will render in dark mode. Example: `dark_mode=true`.

### reduced\_motion

This parameter indicates whether to reduce motion effects in the webpage. It is a boolean value with a default of `false`. This can be helpful for accessibility purposes. Example: `reduced_motion=true`.

## Customization

This section describes the parameters used to customize the capture process. These parameters can help tailor the capture to specific needs or preferences.

### hide\_selectors

This parameter specifies selectors to hide during the capture. It should be an array of strings. This can be useful for removing unwanted elements from the content. Example: `hide_selectors=.ad-banner&hide_selectors=.popup`.

### click\_selector

This parameter specifies a selector to click before taking the capture. It should be a string. This allows for interacting with the page before capturing. Example: `click_selector=.start-button`.

## Geolocation

The geolocation parameters allow you to simulate different geographical locations and conditions in your tests. This can be useful for testing location-based features or services.

### geolocation\_accuracy

This parameter sets the accuracy level for geolocation. It must be an integer between 0 and 1,000. This can help simulate different geolocation scenarios. Example: `geolocation_accuracy=200`.

### geolocation\_latitude

This parameter specifies the latitude for geolocation. It must be a number between -90 and 90. This allows for simulating different geographical locations. Example: `geolocation_latitude=37.7749`.

### geolocation\_longitude

This parameter specifies the longitude for geolocation. It must be a number between -180 and 180. This allows for simulating different geographical locations. Example: `geolocation_longitude=-122.4194`.

## Request

This section describes the parameters that can be used in the request to the API.

### timezone

his parameter specifies the time zone for the capture.\
It should be a string that matches one of the supported time zone names.

This helps simulate different local times during the capture process.\
Example:\
`timezone=America/Los_Angeles`

Supported values:

| Timezone                         |
| -------------------------------- |
| Africa/Abidjan                   |
| Africa/Accra                     |
| Africa/Addis\_Ababa              |
| Africa/Algiers                   |
| Africa/Asmara                    |
| Africa/Bamako                    |
| Africa/Bangui                    |
| Africa/Banjul                    |
| Africa/Bissau                    |
| Africa/Blantyre                  |
| Africa/Brazzaville               |
| Africa/Bujumbura                 |
| Africa/Cairo                     |
| Africa/Casablanca                |
| Africa/Ceuta                     |
| Africa/Conakry                   |
| Africa/Dakar                     |
| Africa/Dar\_es\_Salaam           |
| Africa/Djibouti                  |
| Africa/Douala                    |
| Africa/El\_Aaiun                 |
| Africa/Freetown                  |
| Africa/Gaborone                  |
| Africa/Harare                    |
| Africa/Johannesburg              |
| Africa/Juba                      |
| Africa/Kampala                   |
| Africa/Khartoum                  |
| Africa/Kigali                    |
| Africa/Kinshasa                  |
| Africa/Lagos                     |
| Africa/Libreville                |
| Africa/Lome                      |
| Africa/Luanda                    |
| Africa/Lubumbashi                |
| Africa/Lusaka                    |
| Africa/Malabo                    |
| Africa/Maputo                    |
| Africa/Maseru                    |
| Africa/Mbabane                   |
| Africa/Mogadishu                 |
| Africa/Monrovia                  |
| Africa/Nairobi                   |
| Africa/Ndjamena                  |
| Africa/Niamey                    |
| Africa/Nouakchott                |
| Africa/Ouagadougou               |
| Africa/Porto-Novo                |
| Africa/Sao\_Tome                 |
| Africa/Tripoli                   |
| Africa/Tunis                     |
| Africa/Windhoek                  |
| America/Adak                     |
| America/Anchorage                |
| America/Anguilla                 |
| America/Antigua                  |
| America/Araguaina                |
| America/Argentina/Buenos\_Aires  |
| America/Argentina/Catamarca      |
| America/Argentina/Cordoba        |
| America/Argentina/Jujuy          |
| America/Argentina/La\_Rioja      |
| America/Argentina/Mendoza        |
| America/Argentina/Rio\_Gallegos  |
| America/Argentina/Salta          |
| America/Argentina/San\_Juan      |
| America/Argentina/San\_Luis      |
| America/Argentina/Tucuman        |
| America/Argentina/Ushuaia        |
| America/Aruba                    |
| America/Asuncion                 |
| America/Atikokan                 |
| America/Bahia                    |
| America/Bahia\_Banderas          |
| America/Barbados                 |
| America/Belem                    |
| America/Belize                   |
| America/Blanc-Sablon             |
| America/Boa\_Vista               |
| America/Bogota                   |
| America/Boise                    |
| America/Cambridge\_Bay           |
| America/Campo\_Grande            |
| America/Cancun                   |
| America/Caracas                  |
| America/Cayenne                  |
| America/Cayman                   |
| America/Chicago                  |
| America/Chihuahua                |
| America/Ciudad\_Juarez           |
| America/Costa\_Rica              |
| America/Creston                  |
| America/Cuiaba                   |
| America/Curacao                  |
| America/Danmarkshavn             |
| America/Dawson                   |
| America/Dawson\_Creek            |
| America/Denver                   |
| America/Detroit                  |
| America/Dominica                 |
| America/Edmonton                 |
| America/Eirunepe                 |
| America/El\_Salvador             |
| America/Fort\_Nelson             |
| America/Fortaleza                |
| America/Glace\_Bay               |
| America/Goose\_Bay               |
| America/Grand\_Turk              |
| America/Grenada                  |
| America/Guadeloupe               |
| America/Guatemala                |
| America/Guayaquil                |
| America/Guyana                   |
| America/Halifax                  |
| America/Havana                   |
| America/Hermosillo               |
| America/Indiana/Indianapolis     |
| America/Indiana/Knox             |
| America/Indiana/Marengo          |
| America/Indiana/Petersburg       |
| America/Indiana/Tell\_City       |
| America/Indiana/Vevay            |
| America/Indiana/Vincennes        |
| America/Indiana/Winamac          |
| America/Inuvik                   |
| America/Iqaluit                  |
| America/Jamaica                  |
| America/Juneau                   |
| America/Kentucky/Louisville      |
| America/Kentucky/Monticello      |
| America/Kralendijk               |
| America/La\_Paz                  |
| America/Lima                     |
| America/Los\_Angeles             |
| America/Lower\_Princes           |
| America/Maceio                   |
| America/Managua                  |
| America/Manaus                   |
| America/Marigot                  |
| America/Martinique               |
| America/Matamoros                |
| America/Mazatlan                 |
| America/Menominee                |
| America/Merida                   |
| America/Metlakatla               |
| America/Mexico\_City             |
| America/Miquelon                 |
| America/Moncton                  |
| America/Monterrey                |
| America/Montevideo               |
| America/Montserrat               |
| America/Nassau                   |
| America/New\_York                |
| America/Nome                     |
| America/Noronha                  |
| America/North\_Dakota/Beulah     |
| America/North\_Dakota/Center     |
| America/North\_Dakota/New\_Salem |
| America/Nuuk                     |
| America/Ojinaga                  |
| America/Panama                   |
| America/Paramaribo               |
| America/Phoenix                  |
| America/Port-au-Prince           |
| America/Port\_of\_Spain          |
| America/Porto\_Velho             |
| America/Puerto\_Rico             |
| America/Punta\_Arenas            |
| America/Rankin\_Inlet            |
| America/Recife                   |
| America/Regina                   |
| America/Resolute                 |
| America/Rio\_Branco              |
| America/Santarem                 |
| America/Santiago                 |
| America/Santo\_Domingo           |
| America/Sao\_Paulo               |
| America/Scoresbysund             |
| America/Sitka                    |
| America/St\_Barthelemy           |
| America/St\_Johns                |
| America/St\_Kitts                |
| America/St\_Lucia                |
| America/St\_Thomas               |
| America/St\_Vincent              |
| America/Swift\_Current           |
| America/Tegucigalpa              |
| America/Thule                    |
| America/Tijuana                  |
| America/Toronto                  |
| America/Tortola                  |
| America/Vancouver                |
| America/Whitehorse               |
| America/Winnipeg                 |
| America/Yakutat                  |
| America/Yellowknife              |
| Antarctica/Casey                 |
| Antarctica/Davis                 |
| Antarctica/DumontDUrville        |
| Antarctica/Macquarie             |
| Antarctica/Mawson                |
| Antarctica/McMurdo               |
| Antarctica/Palmer                |
| Antarctica/Rothera               |
| Antarctica/Syowa                 |
| Antarctica/Troll                 |
| Antarctica/Vostok                |
| Arctic/Longyearbyen              |
| Asia/Aden                        |
| Asia/Almaty                      |
| Asia/Amman                       |
| Asia/Anadyr                      |
| Asia/Aqtau                       |
| Asia/Aqtobe                      |
| Asia/Ashgabat                    |
| Asia/Atyrau                      |
| Asia/Baghdad                     |
| Asia/Bahrain                     |
| Asia/Baku                        |
| Asia/Bangkok                     |
| Asia/Barnaul                     |
| Asia/Beirut                      |
| Asia/Bishkek                     |
| Asia/Brunei                      |
| Asia/Chita                       |
| Asia/Choibalsan                  |
| Asia/Colombo                     |
| Asia/Damascus                    |
| Asia/Dhaka                       |
| Asia/Dili                        |
| Asia/Dubai                       |
| Asia/Dushanbe                    |
| Asia/Famagusta                   |
| Asia/Gaza                        |
| Asia/Hebron                      |
| Asia/Ho\_Chi\_Minh               |
| Asia/Hong\_Kong                  |
| Asia/Hovd                        |
| Asia/Irkutsk                     |
| Asia/Jakarta                     |
| Asia/Jayapura                    |
| Asia/Jerusalem                   |
| Asia/Kabul                       |
| Asia/Kamchatka                   |
| Asia/Karachi                     |
| Asia/Kathmandu                   |
| Asia/Khandyga                    |
| Asia/Kolkata                     |
| Asia/Krasnoyarsk                 |
| Asia/Kuala\_Lumpur               |
| Asia/Kuching                     |
| Asia/Kuwait                      |
| Asia/Macau                       |
| Asia/Magadan                     |
| Asia/Makassar                    |
| Asia/Manila                      |
| Asia/Muscat                      |
| Asia/Nicosia                     |
| Asia/Novokuznetsk                |
| Asia/Novosibirsk                 |
| Asia/Omsk                        |
| Asia/Oral                        |
| Asia/Phnom\_Penh                 |
| Asia/Pontianak                   |
| Asia/Pyongyang                   |
| Asia/Qatar                       |
| Asia/Qostanay                    |
| Asia/Qyzylorda                   |
| Asia/Riyadh                      |
| Asia/Sakhalin                    |
| Asia/Samarkand                   |
| Asia/Seoul                       |
| Asia/Shanghai                    |
| Asia/Singapore                   |
| Asia/Srednekolymsk               |
| Asia/Taipei                      |
| Asia/Tashkent                    |
| Asia/Tbilisi                     |
| Asia/Tehran                      |
| Asia/Thimphu                     |
| Asia/Tokyo                       |
| Asia/Tomsk                       |
| Asia/Ulaanbaatar                 |
| Asia/Urumqi                      |
| Asia/Ust-Nera                    |
| Asia/Vientiane                   |
| Asia/Vladivostok                 |
| Asia/Yakutsk                     |
| Asia/Yangon                      |
| Asia/Yekaterinburg               |
| Asia/Yerevan                     |
| Atlantic/Azores                  |
| Atlantic/Bermuda                 |
| Atlantic/Canary                  |
| Atlantic/Cape\_Verde             |
| Atlantic/Faroe                   |
| Atlantic/Madeira                 |
| Atlantic/Reykjavik               |
| Atlantic/South\_Georgia          |
| Atlantic/St\_Helena              |
| Atlantic/Stanley                 |
| Australia/Adelaide               |
| Australia/Brisbane               |
| Australia/Broken\_Hill           |
| Australia/Darwin                 |
| Australia/Eucla                  |
| Australia/Hobart                 |
| Australia/Lindeman               |
| Australia/Lord\_Howe             |
| Australia/Melbourne              |
| Australia/Perth                  |
| Australia/Sydney                 |
| Europe/Amsterdam                 |
| Europe/Andorra                   |
| Europe/Astrakhan                 |
| Europe/Athens                    |
| Europe/Belgrade                  |
| Europe/Berlin                    |
| Europe/Bratislava                |
| Europe/Brussels                  |
| Europe/Bucharest                 |
| Europe/Budapest                  |
| Europe/Busingen                  |
| Europe/Chisinau                  |
| Europe/Copenhagen                |
| Europe/Dublin                    |
| Europe/Gibraltar                 |
| Europe/Guernsey                  |
| Europe/Helsinki                  |
| Europe/Isle\_of\_Man             |
| Europe/Istanbul                  |
| Europe/Jersey                    |
| Europe/Kaliningrad               |
| Europe/Kirov                     |
| Europe/Kyiv                      |
| Europe/Lisbon                    |
| Europe/Ljubljana                 |
| Europe/London                    |
| Europe/Luxembourg                |
| Europe/Madrid                    |
| Europe/Malta                     |
| Europe/Mariehamn                 |
| Europe/Minsk                     |
| Europe/Monaco                    |
| Europe/Moscow                    |
| Europe/Oslo                      |
| Europe/Paris                     |
| Europe/Podgorica                 |
| Europe/Prague                    |
| Europe/Riga                      |
| Europe/Rome                      |
| Europe/Samara                    |
| Europe/San\_Marino               |
| Europe/Sarajevo                  |
| Europe/Saratov                   |
| Europe/Simferopol                |
| Europe/Skopje                    |
| Europe/Sofia                     |
| Europe/Stockholm                 |
| Europe/Tallinn                   |
| Europe/Tirane                    |
| Europe/Ulyanovsk                 |
| Europe/Vaduz                     |
| Europe/Vatican                   |
| Europe/Vienna                    |
| Europe/Vilnius                   |
| Europe/Volgograd                 |
| Europe/Warsaw                    |
| Europe/Zagreb                    |
| Europe/Zurich                    |
| Indian/Antananarivo              |
| Indian/Chagos                    |
| Indian/Christmas                 |
| Indian/Cocos                     |
| Indian/Comoro                    |
| Indian/Kerguelen                 |
| Indian/Mahe                      |
| Indian/Maldives                  |
| Indian/Mauritius                 |
| Indian/Mayotte                   |
| Indian/Reunion                   |
| Pacific/Apia                     |
| Pacific/Auckland                 |
| Pacific/Bougainville             |
| Pacific/Chatham                  |
| Pacific/Chuuk                    |
| Pacific/Easter                   |
| Pacific/Efate                    |
| Pacific/Fakaofo                  |
| Pacific/Fiji                     |
| Pacific/Funafuti                 |
| Pacific/Galapagos                |
| Pacific/Gambier                  |
| Pacific/Guadalcanal              |
| Pacific/Guam                     |
| Pacific/Honolulu                 |
| Pacific/Kanton                   |
| Pacific/Kiritimati               |
| Pacific/Kosrae                   |
| Pacific/Kwajalein                |
| Pacific/Majuro                   |
| Pacific/Marquesas                |
| Pacific/Midway                   |
| Pacific/Nauru                    |
| Pacific/Niue                     |
| Pacific/Norfolk                  |
| Pacific/Noumea                   |
| Pacific/Pago\_Pago               |
| Pacific/Palau                    |
| Pacific/Pitcairn                 |
| Pacific/Pohnpei                  |
| Pacific/Port\_Moresby            |
| Pacific/Rarotonga                |
| Pacific/Saipan                   |
| Pacific/Tahiti                   |
| Pacific/Tarawa                   |
| Pacific/Tongatapu                |
| Pacific/Wake                     |
| Pacific/Wallis                   |

### authorization

Specifies the authorization token to include with the API request, typically used to access protected resources.\
This should be a string encoded in Base64 and passed as the value of the `Authorization` header.

**Example:** `authorization=<base64-encoded-token>`

**Note:** Ensure the token is properly encoded to avoid authentication errors. Common formats include Basic Auth (`username:password`) or Bearer tokens, depending on the target service.

### attachment\_name

This parameter specifies the name of the attachment for the result. It should be a string without the extension. The extension will be computed from the response. This can be useful for identifying the screenshot in a list of attachments. Example: `attachment_name=screenshot`.

### user\_agent

This parameter specifies the user agent string to use for the request. It should be a string. This allows for simulating different browsers or devices. Example: `user_agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3`.

### cookies

This parameter allows for specifying cookies to include in the request. It should be an array of strings. This can be useful for maintaining session state. Example: `cookies=session_id=abc123&cookies=user_id=xyz789`.

### headers

This parameter allows for specifying additional headers to include in the request. It should be an array of strings. This can be useful for passing custom headers. Example: `headers=X-Custom-Header:value`.

### ip\_location

This parameter specifies the IP location to simulate. It should be a string that matches one of the supported values.

Example:\
`ip_location=us`

Supported values:

| Country Code | Country                            |
| ------------ | ---------------------------------- |
| us           | United States                      |
| cn           | China                              |
| eu           | European Union (random EU country) |
| ca           | Canada                             |
| mx           | Mexico                             |
| gb           | United Kingdom                     |
| de           | Germany                            |
| fr           | France                             |
| ch           | Switzerland                        |
| in           | India                              |
| jp           | Japan                              |
| kr           | South Korea                        |
| ru           | Russia                             |
| br           | Brazil                             |
| au           | Australia                          |

### bypass\_csp

This parameter indicates whether to bypass Content Security Policy during the capture. It is a boolean value with a default of `false`. This can be useful for testing pages with strict CSP. Example: `bypass_csp=true`.

### proxy

This parameter specifies a proxy server to use for the request. It should be a string in URI format. This can be useful for routing requests through a specific server. Example: `proxy=http://proxy.example.com:8080`.

## Wait

This section describes the parameters that can be used to control the timing of the capture process.

### delay

This parameter sets a delay in seconds before taking the capture. It must be an integer between 0 and 30, with a default of 0. This can help ensure that the page is fully loaded before capturing. Example: `delay=5`.

### timeout

This parameter sets a timeout in seconds for the request. It must be an integer between 0 and 30, with a default of 30. This can help prevent long waits for unresponsive pages. Example: `timeout=10`.

### wait\_until

This parameter specifies the events to wait for before taking the capture.\
It should be an array of strings that match one of the supported events.\
Default is `domcontentloaded`.

Example: `wait_until=load&wait_until=networkidle0`

| Event              | Description                                                                                       |
| ------------------ | ------------------------------------------------------------------------------------------------- |
| `load`             | Waits for the `load` event to fire (all resources including images and scripts).                  |
| `domcontentloaded` | Waits for the DOMContentLoaded event (when the initial HTML document is fully loaded and parsed). |
| `networkidle0`     | Waits until there are no more than 0 network connections for at least 500 ms.                     |
| `networkidle2`     | Waits until there are no more than 2 network connections for at least 500 ms.                     |

## Metadata

The metadata parameters allow you to include additional information in the capture request. This can be useful for debugging, analysis, or simply to provide more context about the captured content.

### metadata\_icon

This parameter indicates whether to include the website's icon (favicon) in the metadata. It is a boolean value with a default of `false`. Example: `metadata_icon=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Icon` — the URL path to the favicon of the target webpage.

### metadata\_fonts

This parameter indicates whether to include font information in the metadata. It is a boolean value with a default of `false`. This can be useful for analyzing the fonts used on the webpage. Example: `metadata_fonts=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Fonts` — a comma-separated list of fonts used on the page.

### metadata\_title

This parameter indicates whether to include the page title in the metadata. It is a boolean value with a default of `false`. Example: `metadata_title=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Title` — the `<title>` of the target webpage.

### metadata\_status

This parameter indicates whether to include the HTTP status in the metadata. It is a boolean value with a default of `false`. This can be useful for understanding the response status of the request. Example: `metadata_status=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Status` — the HTTP status code of the response.

### metadata\_headers

This parameter indicates whether to include the response headers in the metadata. It is a boolean value with a default of `false`. This can help in analyzing the headers returned by the server. Example: `metadata_headers=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Headers` — a JSON string of all response headers from the target webpage.

### metadata\_hash

This parameter indicates whether to include a hash of the captured content in the metadata. It is a boolean value with a default of `false`. Example: `metadata_hash=true`.
If enabled, the response headers will include:  `X-Screenshotmax-Metadata-Hash` — a SHA-256 hash of the webpage content, useful for change detection.

## Caching

This section outlines the parameters available to configure caching behavior for content responses in API requests.
Captured content can be stored in the cache for a specified duration, enabling faster retrieval of previously processed results.
This helps reduce load times and improve performance for frequently accessed content.

Cached content is accessible via a URL in the following format:
[https://cache.screenshotmax.com/\{hash}.\{ext}](https://cache.screenshotmax.com/\{hash}.\{ext})

In the response headers, the key `X-Screenshotmax-Cache-Url` provides the direct URL to the cached version of the content.

### cache

This parameter indicates whether to enable caching for the result. It is a boolean value with a default of `false`. Example: `cache=true`.

### cache\_ttl

This parameter sets the time-to-live for cached result in seconds. It must be an integer between 1 and 2,592,000 (30 days), with a default of 604,800 (7 days). This controls how long cached results are kept. Example: `cache_ttl=86400`.

## Async and Webhook

This section outlines the parameters used for asynchronous processing and webhook notifications in API requests.

### async

This parameter indicates whether the request should be processed asynchronously. It is a boolean value with a default of `false`. This can be useful for handling long-running requests without blocking. Example: `async=true`.

### webhook\_url

This parameter specifies a webhook URL to send notifications to when the request is completed. It should be a string in URI format.
The webhook URL muste support POST requests and be publicly accessible. Example: `webhook_url=https://example.com/webhook`.

### webhook\_signed

This parameter indicates whether the webhook should be signed for security. It is a boolean value with a default of `true`. This can help ensure that notifications are from a trusted source. Example: `webhook_signed=false`.

The signature is a SHA-256 hash of the request body combined with your secret key. It ensures the authenticity of the notification and protects against tampering.
For details on how to verify the signature, refer to the [signed requests documentation](https://docs.screenshotmax.com/guides/start/signed-requests).


# Screenshot Options
Source: https://docs.screenshotmax.com/guides/references/screenshot-options

Customize screenshot generation with ScreenshotMAX API

<Frame caption="Example of https://stripe.com screenshot">
  ![screesnshot](https://screenshotmax.com/static/media/screenshots/stripe.webp)
</Frame>

## Credentials

### access\_key

This parameter is used to authenticate API requests. It should be a string with a maximum length of 24 characters. Every request to the ScreenshotMAX API must include a valid `access_key`, which identifies the calling account. Example: `access_key=abcd1234efgh5678ijkl9012`.

### signature

This parameter is used to verify the authenticity of the request. It should be a string with a maximum length of 64 characters. The `signature` is generated using the `access_key` and your secret key, ensuring that the request has not been tampered with. Example: `signature=abcd1234efgh5678ijkl9012mnop3456`.

## Essential

### url

Defines the target webpage to capture. This parameter must be a valid URL.

You can pass the URL as either a plain string or a percent-encoded string.\
Use encoded format when the URL contains query parameters to avoid conflicts with the API's own querystring.

**Examples:**

* Plain: `url=https://www.example.com`
* Encoded: `url=https%3A%2F%2Fwww.example.com%3Fparam1%3Dvalue1%26param2%3Dvalue2`

### html

This parameter allows you to provide raw HTML content to render and capture as a screenshot
It must be a valid HTML string.

**Either `url` or `html` must be provided.**

Example:
`html=<html><body><h1>Hello, World!</h1></body></html>`

### format

This parameter specifies the format of the screenshot image.\
It should be a string that matches one of the supported values.

**Default value:** `jpeg`

Example:\
`format=png`

Supported values:

| Value | Description                       |
| ----- | --------------------------------- |
| png   | PNG image format (lossless)       |
| jpg   | JPEG image format (alias of jpeg) |
| jpeg  | JPEG image format (default)       |
| webp  | WebP image format (compressed)    |
| gif   | GIF image format (static)         |

### image\_quality

This parameter specifies the quality of the image. It is an integer value between `1` and `100`, where `1` is the lowest quality and `100` is the highest quality. The default value is `80`.

### image\_width

This parameter specifies the width of the screenshot image in pixels. It is an integer value greater than or equal to `0`. The default value is `0`, which means the image will be captured at the original width.

### image\_height

This parameter specifies the height of the screenshot image in pixels. It is an integer value greater than or equal to `0`. The default value is `0`, which means the image will be captured at the original height.

### omit\_background

This parameter indicates whether to render a transparent background for the image. It is useful when the site does not define a background color. The default value is `false`.

## Full Page

This section describes the parameters used to control the full-page screenshot behavior. These parameters can help capture the entire webpage, including content that may not be visible in the viewport.

### full\_page

This parameter indicates whether to capture a full-page screenshot. When set to `true`, the API captures the entire webpage, including content that may not be visible in the viewport. The default value is `false`.

### full\_page\_scroll

This parameter controls whether to scroll the page to capture the full content.
When set to `true`, the API will automatically scroll from the top of the page to the bottom and then back up to the top before taking the screenshot. This behavior ensures that content loaded dynamically on scroll — such as images with lazy loading or infinite-scroll sections — is properly rendered and included in the capture.
This is especially useful for pages where elements (like images or data) are only loaded into the DOM when they become visible in the viewport.

### full\_page\_scroll\_by\_amount

This parameter specifies the amount to scroll the page when capturing a full-page screenshot. It is an integer value that represents the number of pixels to scroll. The default value is `0`, which means no scrolling.

### full\_page\_scroll\_by\_duration

This parameter specifies the duration of the scroll when capturing a full-page screenshot. It is an integer value that represents the time in milliseconds to wait before scrolling again. The default value is `400` milliseconds.

## GPU

### gpu\_rendering

This parameter determines whether to enable GPU rendering for the webpage. It should be a boolean value, with a default of `false`. Enabling GPU rendering can improve the quality of the capture for complex webpages. Example: `gpu_rendering=true`.

## Viewport

This section describes the parameters used to control the viewport settings for captures. These parameters can help simulate different devices and screen sizes.

### capture\_beyond\_viewport

This parameter allows capturing content beyond the viewport. It is a boolean value with a default of `false`. When set to `true`, the API will capture content that is not currently visible in the viewport. Example: `capture_beyond_viewport=true`.

### viewport\_device

This parameter specifies the device type to simulate for the viewport.\
It should be a string that matches one of the supported device names.

Using this parameter allows the API to emulate different screen sizes and behaviors when capturing screenshots.

Example:\
`viewport_device=iphone_13`

The full list of supported devices is available via the `/devices` endpoint.\
[More information →](https://docs.screenshotmax.com/endpoints/devices)

### viewport\_width

This parameter sets the width of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport width can help capture screenshots that match specific screen sizes. Example: `viewport_width=1280`.

### viewport\_height

This parameter sets the height of the viewport in pixels. It must be an integer greater than or equal to 0. Adjusting the viewport height can help capture screenshots that match specific screen sizes. Example: `viewport_height=720`.

### viewport\_landscape

This parameter specifies whether the viewport should be in landscape mode. It is a boolean value. Setting this to `true` will change the orientation of the viewport. Example: `viewport_landscape=true`.

### viewport\_has\_touch

This parameter indicates whether the viewport has touch capabilities. It is a boolean value. This affects how the page is rendered and can be useful for mobile simulations. Example: `viewport_has_touch=true`.

### viewport\_mobile

This parameter indicates whether the viewport is a mobile device. It is a boolean value. Setting this to `true` will simulate a mobile device environment. Example: `viewport_mobile=true`.

### device\_scale\_factor

This parameter determines the device scale factor for the viewport. It should be a number between 1 and 5. This affects the pixel density of the screen. Example: `device_scale_factor=2`.

## Clip

This section explains the clipping parameters used to define which parts of a webpage are captured.

### clip\_x

This parameter specifies the x-coordinate  of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_x=100`.

### clip\_y

This parameter specifies the y-coordinate of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_y=100`.

### clip\_width

This parameter sets the width of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_width=800`.

### clip\_height

This parameter sets the height of the clipped area. It must be an integer greater than or equal to 0. This allows for capturing a specific area of the page. Example: `clip_height=600`.

## Blocking

This section describes the parameters used to block certain elements or resources during the rendering process of the webpage. These parameters help enhance capture speed and content quality by removing unnecessary elements.

### block\_annoyance

This parameter specifies the type of annoyance to block during the capture.\
It should be a string that matches one of the supported values.

Default value: `cookies_banner`\
Example:\
`block_annoyance=ads`

Supported values:

| Value           | Description                            |
| --------------- | -------------------------------------- |
| none            | No blocking; capture the page as-is    |
| ads             | Block advertisements                   |
| tracking        | Block tracking scripts and pixels      |
| cookies\_banner | Block cookie consent banners (default) |

### block\_ressources

This parameter specifies the types of resources to block during the capture.\
It should be an array of strings that match the supported resource types.

Example:\
`block_ressources=image&block_ressources=stylesheet`

Supported resource types:

| Resource Type | Description                             |
| ------------- | --------------------------------------- |
| document      | Main HTML documents                     |
| stylesheet    | CSS stylesheets                         |
| image         | Images (e.g., JPEG, PNG, SVG)           |
| media         | Audio and video files                   |
| font          | Web fonts                               |
| script        | JavaScript files                        |
| texttrack     | Text tracks for media (e.g., subtitles) |
| xhr           | XMLHttpRequests (AJAX calls)            |
| fetch         | Fetch API requests                      |
| eventsource   | Server-Sent Events (SSE)                |
| websocket     | WebSocket connections                   |
| manifest      | Web app manifests                       |
| other         | Other types not explicitly listed above |

## Emulation

This section describes the parameters used to control the emulation behavior for captures. These parameters can help simulate different environments and conditions for capturing webpages.

### media\_type

This parameter specifies the media type for the webpage. It should be a string that matches either `screen` or `print`, with a default of `screen`. This affects how the page is rendered. Example: `media_type=print`.

### vision\_deficiency

This parameter indicates the type of vision deficiency to simulate.\
It should be a string that matches one of the supported values.

This can help test accessibility and ensure your content is perceivable by users with visual impairments.

Example:\
`vision_deficiency=deuteranopia`

Supported values:

| Value             | Description                            |
| ----------------- | -------------------------------------- |
| achromatopsia     | Complete color blindness               |
| deuteranopia      | Red-green color blindness (green-weak) |
| blurred\_vision   | Simulates blurred vision               |
| reduced\_contrast | Simulates reduced contrast sensitivity |

### dark\_mode

This parameter indicates whether to enable dark mode for the webpage. It is a boolean value with a default of `false`. When set to `true`, the screenshot will render in dark mode. Example: `dark_mode=true`.

### reduced\_motion

This parameter indicates whether to reduce motion effects in the webpage. It is a boolean value with a default of `false`. This can be helpful for accessibility purposes. Example: `reduced_motion=true`.

## Customization

This section describes the parameters used to customize the capture process. These parameters can help tailor the capture to specific needs or preferences.

### hide\_selectors

This parameter specifies selectors to hide during the capture. It should be an array of strings. This can be useful for removing unwanted elements from the content. Example: `hide_selectors=.ad-banner&hide_selectors=.popup`.

### click\_selector

This parameter specifies a selector to click before taking the capture. It should be a string. This allows for interacting with the page before capturing. Example: `click_selector=.start-button`.

## Geolocation

The geolocation parameters allow you to simulate different geographical locations and conditions in your tests. This can be useful for testing location-based features or services.

### geolocation\_accuracy

This parameter sets the accuracy level for geolocation. It must be an integer between 0 and 1,000. This can help simulate different geolocation scenarios. Example: `geolocation_accuracy=200`.

### geolocation\_latitude

This parameter specifies the latitude for geolocation. It must be a number between -90 and 90. This allows for simulating different geographical locations. Example: `geolocation_latitude=37.7749`.

### geolocation\_longitude

This parameter specifies the longitude for geolocation. It must be a number between -180 and 180. This allows for simulating different geographical locations. Example: `geolocation_longitude=-122.4194`.

## Request

This section describes the parameters that can be used in the request to the API.

### timezone

his parameter specifies the time zone for the capture.\
It should be a string that matches one of the supported time zone names.

This helps simulate different local times during the capture process.\
Example:\
`timezone=America/Los_Angeles`

Supported values:

| Timezone                         |
| -------------------------------- |
| Africa/Abidjan                   |
| Africa/Accra                     |
| Africa/Addis\_Ababa              |
| Africa/Algiers                   |
| Africa/Asmara                    |
| Africa/Bamako                    |
| Africa/Bangui                    |
| Africa/Banjul                    |
| Africa/Bissau                    |
| Africa/Blantyre                  |
| Africa/Brazzaville               |
| Africa/Bujumbura                 |
| Africa/Cairo                     |
| Africa/Casablanca                |
| Africa/Ceuta                     |
| Africa/Conakry                   |
| Africa/Dakar                     |
| Africa/Dar\_es\_Salaam           |
| Africa/Djibouti                  |
| Africa/Douala                    |
| Africa/El\_Aaiun                 |
| Africa/Freetown                  |
| Africa/Gaborone                  |
| Africa/Harare                    |
| Africa/Johannesburg              |
| Africa/Juba                      |
| Africa/Kampala                   |
| Africa/Khartoum                  |
| Africa/Kigali                    |
| Africa/Kinshasa                  |
| Africa/Lagos                     |
| Africa/Libreville                |
| Africa/Lome                      |
| Africa/Luanda                    |
| Africa/Lubumbashi                |
| Africa/Lusaka                    |
| Africa/Malabo                    |
| Africa/Maputo                    |
| Africa/Maseru                    |
| Africa/Mbabane                   |
| Africa/Mogadishu                 |
| Africa/Monrovia                  |
| Africa/Nairobi                   |
| Africa/Ndjamena                  |
| Africa/Niamey                    |
| Africa/Nouakchott                |
| Africa/Ouagadougou               |
| Africa/Porto-Novo                |
| Africa/Sao\_Tome                 |
| Africa/Tripoli                   |
| Africa/Tunis                     |
| Africa/Windhoek                  |
| America/Adak                     |
| America/Anchorage                |
| America/Anguilla                 |
| America/Antigua                  |
| America/Araguaina                |
| America/Argentina/Buenos\_Aires  |
| America/Argentina/Catamarca      |
| America/Argentina/Cordoba        |
| America/Argentina/Jujuy          |
| America/Argentina/La\_Rioja      |
| America/Argentina/Mendoza        |
| America/Argentina/Rio\_Gallegos  |
| America/Argentina/Salta          |
| America/Argentina/San\_Juan      |
| America/Argentina/San\_Luis      |
| America/Argentina/Tucuman        |
| America/Argentina/Ushuaia        |
| America/Aruba                    |
| America/Asuncion                 |
| America/Atikokan                 |
| America/Bahia                    |
| America/Bahia\_Banderas          |
| America/Barbados                 |
| America/Belem                    |
| America/Belize                   |
| America/Blanc-Sablon             |
| America/Boa\_Vista               |
| America/Bogota                   |
| America/Boise                    |
| America/Cambridge\_Bay           |
| America/Campo\_Grande            |
| America/Cancun                   |
| America/Caracas                  |
| America/Cayenne                  |
| America/Cayman                   |
| America/Chicago                  |
| America/Chihuahua                |
| America/Ciudad\_Juarez           |
| America/Costa\_Rica              |
| America/Creston                  |
| America/Cuiaba                   |
| America/Curacao                  |
| America/Danmarkshavn             |
| America/Dawson                   |
| America/Dawson\_Creek            |
| America/Denver                   |
| America/Detroit                  |
| America/Dominica                 |
| America/Edmonton                 |
| America/Eirunepe                 |
| America/El\_Salvador             |
| America/Fort\_Nelson             |
| America/Fortaleza                |
| America/Glace\_Bay               |
| America/Goose\_Bay               |
| America/Grand\_Turk              |
| America/Grenada                  |
| America/Guadeloupe               |
| America/Guatemala                |
| America/Guayaquil                |
| America/Guyana                   |
| America/Halifax                  |
| America/Havana                   |
| America/Hermosillo               |
| America/Indiana/Indianapolis     |
| America/Indiana/Knox             |
| America/Indiana/Marengo          |
| America/Indiana/Petersburg       |
| America/Indiana/Tell\_City       |
| America/Indiana/Vevay            |
| America/Indiana/Vincennes        |
| America/Indiana/Winamac          |
| America/Inuvik                   |
| America/Iqaluit                  |
| America/Jamaica                  |
| America/Juneau                   |
| America/Kentucky/Louisville      |
| America/Kentucky/Monticello      |
| America/Kralendijk               |
| America/La\_Paz                  |
| America/Lima                     |
| America/Los\_Angeles             |
| America/Lower\_Princes           |
| America/Maceio                   |
| America/Managua                  |
| America/Manaus                   |
| America/Marigot                  |
| America/Martinique               |
| America/Matamoros                |
| America/Mazatlan                 |
| America/Menominee                |
| America/Merida                   |
| America/Metlakatla               |
| America/Mexico\_City             |
| America/Miquelon                 |
| America/Moncton                  |
| America/Monterrey                |
| America/Montevideo               |
| America/Montserrat               |
| America/Nassau                   |
| America/New\_York                |
| America/Nome                     |
| America/Noronha                  |
| America/North\_Dakota/Beulah     |
| America/North\_Dakota/Center     |
| America/North\_Dakota/New\_Salem |
| America/Nuuk                     |
| America/Ojinaga                  |
| America/Panama                   |
| America/Paramaribo               |
| America/Phoenix                  |
| America/Port-au-Prince           |
| America/Port\_of\_Spain          |
| America/Porto\_Velho             |
| America/Puerto\_Rico             |
| America/Punta\_Arenas            |
| America/Rankin\_Inlet            |
| America/Recife                   |
| America/Regina                   |
| America/Resolute                 |
| America/Rio\_Branco              |
| America/Santarem                 |
| America/Santiago                 |
| America/Santo\_Domingo           |
| America/Sao\_Paulo               |
| America/Scoresbysund             |
| America/Sitka                    |
| America/St\_Barthelemy           |
| America/St\_Johns                |
| America/St\_Kitts                |
| America/St\_Lucia                |
| America/St\_Thomas               |
| America/St\_Vincent              |
| America/Swift\_Current           |
| America/Tegucigalpa              |
| America/Thule                    |
| America/Tijuana                  |
| America/Toronto                  |
| America/Tortola                  |
| America/Vancouver                |
| America/Whitehorse               |
| America/Winnipeg                 |
| America/Yakutat                  |
| America/Yellowknife              |
| Antarctica/Casey                 |
| Antarctica/Davis                 |
| Antarctica/DumontDUrville        |
| Antarctica/Macquarie             |
| Antarctica/Mawson                |
| Antarctica/McMurdo               |
| Antarctica/Palmer                |
| Antarctica/Rothera               |
| Antarctica/Syowa                 |
| Antarctica/Troll                 |
| Antarctica/Vostok                |
| Arctic/Longyearbyen              |
| Asia/Aden                        |
| Asia/Almaty                      |
| Asia/Amman                       |
| Asia/Anadyr                      |
| Asia/Aqtau                       |
| Asia/Aqtobe                      |
| Asia/Ashgabat                    |
| Asia/Atyrau                      |
| Asia/Baghdad                     |
| Asia/Bahrain                     |
| Asia/Baku                        |
| Asia/Bangkok                     |
| Asia/Barnaul                     |
| Asia/Beirut                      |
| Asia/Bishkek                     |
| Asia/Brunei                      |
| Asia/Chita                       |
| Asia/Choibalsan                  |
| Asia/Colombo                     |
| Asia/Damascus                    |
| Asia/Dhaka                       |
| Asia/Dili                        |
| Asia/Dubai                       |
| Asia/Dushanbe                    |
| Asia/Famagusta                   |
| Asia/Gaza                        |
| Asia/Hebron                      |
| Asia/Ho\_Chi\_Minh               |
| Asia/Hong\_Kong                  |
| Asia/Hovd                        |
| Asia/Irkutsk                     |
| Asia/Jakarta                     |
| Asia/Jayapura                    |
| Asia/Jerusalem                   |
| Asia/Kabul                       |
| Asia/Kamchatka                   |
| Asia/Karachi                     |
| Asia/Kathmandu                   |
| Asia/Khandyga                    |
| Asia/Kolkata                     |
| Asia/Krasnoyarsk                 |
| Asia/Kuala\_Lumpur               |
| Asia/Kuching                     |
| Asia/Kuwait                      |
| Asia/Macau                       |
| Asia/Magadan                     |
| Asia/Makassar                    |
| Asia/Manila                      |
| Asia/Muscat                      |
| Asia/Nicosia                     |
| Asia/Novokuznetsk                |
| Asia/Novosibirsk                 |
| Asia/Omsk                        |
| Asia/Oral                        |
| Asia/Phnom\_Penh                 |
| Asia/Pontianak                   |
| Asia/Pyongyang                   |
| Asia/Qatar                       |
| Asia/Qostanay                    |
| Asia/Qyzylorda                   |
| Asia/Riyadh                      |
| Asia/Sakhalin                    |
| Asia/Samarkand                   |
| Asia/Seoul                       |
| Asia/Shanghai                    |
| Asia/Singapore                   |
| Asia/Srednekolymsk               |
| Asia/Taipei                      |
| Asia/Tashkent                    |
| Asia/Tbilisi                     |
| Asia/Tehran                      |
| Asia/Thimphu                     |
| Asia/Tokyo                       |
| Asia/Tomsk                       |
| Asia/Ulaanbaatar                 |
| Asia/Urumqi                      |
| Asia/Ust-Nera                    |
| Asia/Vientiane                   |
| Asia/Vladivostok                 |
| Asia/Yakutsk                     |
| Asia/Yangon                      |
| Asia/Yekaterinburg               |
| Asia/Yerevan                     |
| Atlantic/Azores                  |
| Atlantic/Bermuda                 |
| Atlantic/Canary                  |
| Atlantic/Cape\_Verde             |
| Atlantic/Faroe                   |
| Atlantic/Madeira                 |
| Atlantic/Reykjavik               |
| Atlantic/South\_Georgia          |
| Atlantic/St\_Helena              |
| Atlantic/Stanley                 |
| Australia/Adelaide               |
| Australia/Brisbane               |
| Australia/Broken\_Hill           |
| Australia/Darwin                 |
| Australia/Eucla                  |
| Australia/Hobart                 |
| Australia/Lindeman               |
| Australia/Lord\_Howe             |
| Australia/Melbourne              |
| Australia/Perth                  |
| Australia/Sydney                 |
| Europe/Amsterdam                 |
| Europe/Andorra                   |
| Europe/Astrakhan                 |
| Europe/Athens                    |
| Europe/Belgrade                  |
| Europe/Berlin                    |
| Europe/Bratislava                |
| Europe/Brussels                  |
| Europe/Bucharest                 |
| Europe/Budapest                  |
| Europe/Busingen                  |
| Europe/Chisinau                  |
| Europe/Copenhagen                |
| Europe/Dublin                    |
| Europe/Gibraltar                 |
| Europe/Guernsey                  |
| Europe/Helsinki                  |
| Europe/Isle\_of\_Man             |
| Europe/Istanbul                  |
| Europe/Jersey                    |
| Europe/Kaliningrad               |
| Europe/Kirov                     |
| Europe/Kyiv                      |
| Europe/Lisbon                    |
| Europe/Ljubljana                 |
| Europe/London                    |
| Europe/Luxembourg                |
| Europe/Madrid                    |
| Europe/Malta                     |
| Europe/Mariehamn                 |
| Europe/Minsk                     |
| Europe/Monaco                    |
| Europe/Moscow                    |
| Europe/Oslo                      |
| Europe/Paris                     |
| Europe/Podgorica                 |
| Europe/Prague                    |
| Europe/Riga                      |
| Europe/Rome                      |
| Europe/Samara                    |
| Europe/San\_Marino               |
| Europe/Sarajevo                  |
| Europe/Saratov                   |
| Europe/Simferopol                |
| Europe/Skopje                    |
| Europe/Sofia                     |
| Europe/Stockholm                 |
| Europe/Tallinn                   |
| Europe/Tirane                    |
| Europe/Ulyanovsk                 |
| Europe/Vaduz                     |
| Europe/Vatican                   |
| Europe/Vienna                    |
| Europe/Vilnius                   |
| Europe/Volgograd                 |
| Europe/Warsaw                    |
| Europe/Zagreb                    |
| Europe/Zurich                    |
| Indian/Antananarivo              |
| Indian/Chagos                    |
| Indian/Christmas                 |
| Indian/Cocos                     |
| Indian/Comoro                    |
| Indian/Kerguelen                 |
| Indian/Mahe                      |
| Indian/Maldives                  |
| Indian/Mauritius                 |
| Indian/Mayotte                   |
| Indian/Reunion                   |
| Pacific/Apia                     |
| Pacific/Auckland                 |
| Pacific/Bougainville             |
| Pacific/Chatham                  |
| Pacific/Chuuk                    |
| Pacific/Easter                   |
| Pacific/Efate                    |
| Pacific/Fakaofo                  |
| Pacific/Fiji                     |
| Pacific/Funafuti                 |
| Pacific/Galapagos                |
| Pacific/Gambier                  |
| Pacific/Guadalcanal              |
| Pacific/Guam                     |
| Pacific/Honolulu                 |
| Pacific/Kanton                   |
| Pacific/Kiritimati               |
| Pacific/Kosrae                   |
| Pacific/Kwajalein                |
| Pacific/Majuro                   |
| Pacific/Marquesas                |
| Pacific/Midway                   |
| Pacific/Nauru                    |
| Pacific/Niue                     |
| Pacific/Norfolk                  |
| Pacific/Noumea                   |
| Pacific/Pago\_Pago               |
| Pacific/Palau                    |
| Pacific/Pitcairn                 |
| Pacific/Pohnpei                  |
| Pacific/Port\_Moresby            |
| Pacific/Rarotonga                |
| Pacific/Saipan                   |
| Pacific/Tahiti                   |
| Pacific/Tarawa                   |
| Pacific/Tongatapu                |
| Pacific/Wake                     |
| Pacific/Wallis                   |

### authorization

Specifies the authorization token to include with the API request, typically used to access protected resources.\
This should be a string encoded in Base64 and passed as the value of the `Authorization` header.

**Example:** `authorization=<base64-encoded-token>`

**Note:** Ensure the token is properly encoded to avoid authentication errors. Common formats include Basic Auth (`username:password`) or Bearer tokens, depending on the target service.

### attachment\_name

This parameter specifies the name of the attachment for the result. It should be a string without the extension. The extension will be computed from the response. This can be useful for identifying the screenshot in a list of attachments. Example: `attachment_name=screenshot`.

### user\_agent

This parameter specifies the user agent string to use for the request. It should be a string. This allows for simulating different browsers or devices. Example: `user_agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3`.

### cookies

This parameter allows for specifying cookies to include in the request. It should be an array of strings. This can be useful for maintaining session state. Example: `cookies=session_id=abc123&cookies=user_id=xyz789`.

### headers

This parameter allows for specifying additional headers to include in the request. It should be an array of strings. This can be useful for passing custom headers. Example: `headers=X-Custom-Header:value`.

### ip\_location

This parameter specifies the IP location to simulate. It should be a string that matches one of the supported values.

Example:\
`ip_location=us`

Supported values:

| Country Code | Country                            |
| ------------ | ---------------------------------- |
| us           | United States                      |
| cn           | China                              |
| eu           | European Union (random EU country) |
| ca           | Canada                             |
| mx           | Mexico                             |
| gb           | United Kingdom                     |
| de           | Germany                            |
| fr           | France                             |
| ch           | Switzerland                        |
| in           | India                              |
| jp           | Japan                              |
| kr           | South Korea                        |
| ru           | Russia                             |
| br           | Brazil                             |
| au           | Australia                          |

### bypass\_csp

This parameter indicates whether to bypass Content Security Policy during the capture. It is a boolean value with a default of `false`. This can be useful for testing pages with strict CSP. Example: `bypass_csp=true`.

### proxy

This parameter specifies a proxy server to use for the request. It should be a string in URI format. This can be useful for routing requests through a specific server. Example: `proxy=http://proxy.example.com:8080`.

## Wait

This section describes the parameters that can be used to control the timing of the capture process.

### delay

This parameter sets a delay in seconds before taking the capture. It must be an integer between 0 and 30, with a default of 0. This can help ensure that the page is fully loaded before capturing. Example: `delay=5`.

### timeout

This parameter sets a timeout in seconds for the request. It must be an integer between 0 and 30, with a default of 30. This can help prevent long waits for unresponsive pages. Example: `timeout=10`.

### wait\_until

This parameter specifies the events to wait for before taking the capture.\
It should be an array of strings that match one of the supported events.\
Default is `domcontentloaded`.

Example: `wait_until=load&wait_until=networkidle0`

| Event              | Description                                                                                       |
| ------------------ | ------------------------------------------------------------------------------------------------- |
| `load`             | Waits for the `load` event to fire (all resources including images and scripts).                  |
| `domcontentloaded` | Waits for the DOMContentLoaded event (when the initial HTML document is fully loaded and parsed). |
| `networkidle0`     | Waits until there are no more than 0 network connections for at least 500 ms.                     |
| `networkidle2`     | Waits until there are no more than 2 network connections for at least 500 ms.                     |

## Metadata

The metadata parameters allow you to include additional information in the capture request. This can be useful for debugging, analysis, or simply to provide more context about the captured content.

### metadata\_icon

This parameter indicates whether to include the website's icon (favicon) in the metadata. It is a boolean value with a default of `false`. Example: `metadata_icon=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Icon` — the URL path to the favicon of the target webpage.

### metadata\_fonts

This parameter indicates whether to include font information in the metadata. It is a boolean value with a default of `false`. This can be useful for analyzing the fonts used on the webpage. Example: `metadata_fonts=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Fonts` — a comma-separated list of fonts used on the page.

### metadata\_title

This parameter indicates whether to include the page title in the metadata. It is a boolean value with a default of `false`. Example: `metadata_title=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Title` — the `<title>` of the target webpage.

### metadata\_status

This parameter indicates whether to include the HTTP status in the metadata. It is a boolean value with a default of `false`. This can be useful for understanding the response status of the request. Example: `metadata_status=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Status` — the HTTP status code of the response.

### metadata\_headers

This parameter indicates whether to include the response headers in the metadata. It is a boolean value with a default of `false`. This can help in analyzing the headers returned by the server. Example: `metadata_headers=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Headers` — a JSON string of all response headers from the target webpage.

### metadata\_hash

This parameter indicates whether to include a hash of the captured content in the metadata. It is a boolean value with a default of `false`. Example: `metadata_hash=true`.
If enabled, the response headers will include:  `X-Screenshotmax-Metadata-Hash` — a SHA-256 hash of the webpage content, useful for change detection.

### metadata\_image\_size

This parameter indicates whether to include the size of the captured image in the metadata. It is a boolean value with a default of `false`. Example: `metadata_image_size=true`.
If enabled, the response headers will include: `X-Screenshotmax-Metadata-Image-Size` — the width and height of the captured image in pixels (e.g., `1920x1080`).

## Caching

This section outlines the parameters available to configure caching behavior for content responses in API requests.
Captured content can be stored in the cache for a specified duration, enabling faster retrieval of previously processed results.
This helps reduce load times and improve performance for frequently accessed content.

Cached content is accessible via a URL in the following format:
[https://cache.screenshotmax.com/\{hash}.\{ext}](https://cache.screenshotmax.com/\{hash}.\{ext})

In the response headers, the key `X-Screenshotmax-Cache-Url` provides the direct URL to the cached version of the content.

### cache

This parameter indicates whether to enable caching for the result. It is a boolean value with a default of `false`. Example: `cache=true`.

### cache\_ttl

This parameter sets the time-to-live for cached result in seconds. It must be an integer between 1 and 2,592,000 (30 days), with a default of 604,800 (7 days). This controls how long cached results are kept. Example: `cache_ttl=86400`.

## Async and Webhook

This section outlines the parameters used for asynchronous processing and webhook notifications in API requests.

### async

This parameter indicates whether the request should be processed asynchronously. It is a boolean value with a default of `false`. This can be useful for handling long-running requests without blocking. Example: `async=true`.

### webhook\_url

This parameter specifies a webhook URL to send notifications to when the request is completed. It should be a string in URI format.
The webhook URL muste support POST requests and be publicly accessible. Example: `webhook_url=https://example.com/webhook`.

### webhook\_signed

This parameter indicates whether the webhook should be signed for security. It is a boolean value with a default of `true`. This can help ensure that notifications are from a trusted source. Example: `webhook_signed=false`.

The signature is a SHA-256 hash of the request body combined with your secret key. It ensures the authenticity of the notification and protects against tampering.
For details on how to verify the signature, refer to the [signed requests documentation](https://docs.screenshotmax.com/guides/start/signed-requests).


# Get Usage
Source: https://docs.screenshotmax.com/guides/references/usage

Get usage statistics for your account



# C#
Source: https://docs.screenshotmax.com/guides/sdks/csharp

The ScreenshotMAX C# SDK provides a streamlined interface for integrating ScreenshotMAX’s screenshot capabilities into your Go applications. It simplifies tasks such as authentication, request signing, and interacting with the ScreenshotMAX API.



# Go Code Samples
Source: https://docs.screenshotmax.com/guides/sdks/go

Use ScreenshotMAX API in Go to capture website screenshots, automate rendering tasks, and securely generate images with signed API requests. Fast, reliable, and developer-friendly.

## ScreenshotMAX with Go

Use Go to interact with the ScreenshotMAX API via `net/http`. Below are examples for simple and signed screenshot requests.

### Basic GET Screenshot

```go
package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
    "os"
)

func main() {
    endpoint := "https://api.screenshotmax.com/v1/screenshot"
    params := url.Values{}
    params.Add("access_key", "YOUR_ACCESS_KEY")
    params.Add("url", "https://example.com")
    params.Add("format", "png")

    fullURL := endpoint + "?" + params.Encode()

    resp, err := http.Get(fullURL)
    if err != nil {
        fmt.Println("Request failed:", err)
        return
    }
    defer resp.Body.Close()

    out, err := os.Create("screenshot.png")
    if err != nil {
        fmt.Println("File error:", err)
        return
    }
    defer out.Close()

    io.Copy(out, resp.Body)
    fmt.Println("Image saved to screenshot.png")
}
```

***

### HMAC-Signed GET Screenshot

```go
package main

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
    "fmt"
    "io"
    "net/http"
    "net/url"
    "os"
)

func main() {
    accessKey := "YOUR_ACCESS_KEY"
    secretKey := "YOUR_SECRET_KEY"

    baseURL := "https://api.screenshotmax.com/v1/screenshot"

    query := url.Values{}
    query.Set("access_key", accessKey)
    query.Set("url", "https://example.com")
    query.Set("format", "png")

    qs := query.Encode()
    signature := signHMAC(qs, secretKey)

    // Add signature to query
    query.Set("signature", signature)

    fullURL := baseURL + "?" + query.Encode()

    resp, err := http.Get(fullURL)
    if err != nil {
        fmt.Println("Request failed:", err)
        return
    }
    defer resp.Body.Close()

    out, _ := os.Create("screenshot.png")
    io.Copy(out, resp.Body)
    fmt.Println("Image saved to screenshot.png")
}

func signHMAC(message, secret string) string {
    mac := hmac.New(sha256.New, []byte(secret))
    mac.Write([]byte(message))
    return hex.EncodeToString(mac.Sum(nil))
}
```

***

## Next Steps

* Explore other API options like HTML to PDF, animated screenshots, or web scraping.
* Create scheduled recurring screenshots via [**Scheduled Tasks API**](/guides/start/scheduled-tasks)

## Support

For questions, issues, or feature requests, please contact our support team at [support@screenshotmax.com](mailto:support@screenshotmax.com).


# Java Code Samples
Source: https://docs.screenshotmax.com/guides/sdks/java

Use ScreenshotMAX API in Java to capture website screenshots, automate rendering tasks, and securely generate images with signed API requests. Fast, reliable, and developer-friendly.

## ScreenshotMAX with Java

Use Java's built-in HTTP client (`java.net.http`) to make signed or direct API calls.

### Basic GET Screenshot

```java
import java.io.*;
import java.net.*;

public class Main {
    public static void main(String[] args) throws Exception {
        String accessKey = "YOUR_ACCESS_KEY";
        String api = "https://api.screenshotmax.com/v1/screenshot";
        String params = String.format("access_key=%s&url=%s&format=png",
            accessKey,
            URLEncoder.encode("https://example.com", "UTF-8"));

        URL url = new URL(api + "?" + params);
        InputStream in = url.openStream();
        Files.copy(in, Path.of("screenshot.png"), StandardCopyOption.REPLACE_EXISTING);
        in.close();
        System.out.println("Image saved to screenshot.png");
    }
}
```

***

### HMAC-Signed GET Screenshot

```java
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.InputStream;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;

public class ScreenshotMAX {
    public static void main(String[] args) throws Exception {
        String accessKey = "YOUR_ACCESS_KEY";
        String secretKey = "YOUR_SECRET_KEY";
        String api = "https://api.screenshotmax.com/v1/screenshot";

        String urlParam = URLEncoder.encode("https://example.com", "UTF-8");
        String format = "png";
        String query = "url=" + urlParam + "&format=" + format + "&access_key=" + accessKey;

        String signature = sign(secretKey, query);

        String finalURL = api + "?" + query + "&signature=" + signature;

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(finalURL))
            .GET()
            .build();

        HttpClient client = HttpClient.newHttpClient();
        HttpResponse<InputStream> response = client.send(request, HttpResponse.BodyHandlers.ofInputStream());

        Files.copy(response.body(), Path.of("screenshot.png"));
        System.out.println("Screenshot saved to screenshot.png");
    }

    private static String sign(String key, String message) throws Exception {
        Mac hmac = Mac.getInstance("HmacSHA256");
        hmac.init(new SecretKeySpec(key.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
        byte[] hash = hmac.doFinal(message.getBytes(StandardCharsets.UTF_8));

        StringBuilder hex = new StringBuilder();
        for (byte b : hash) {
            hex.append(String.format("%02x", b));
        }
        return hex.toString();
    }
}
```

***

## Next Steps

* Explore other API options like HTML to PDF, animated screenshots, or web scraping.
* Create scheduled recurring screenshots via [**Scheduled Tasks API**](/guides/start/scheduled-tasks)

## Support

For questions, issues, or feature requests, please contact our support team at [support@screenshotmax.com](mailto:support@screenshotmax.com).


# JavaScript TypeScript SDK
Source: https://docs.screenshotmax.com/guides/sdks/nodejs-javascript-typescript

The ScreenshotMAX SDK for JavaScript and TypeScript offers a clean, developer-friendly interface for accessing the ScreenshotMAX API. It handles authentication, request signing, and URL generation, making it easy to capture screenshots and integrate advanced rendering features into your applications with minimal setup.

The SDK client stays up-to-date with the latest API capabilities.

# Getting Started

#### Install the SDK using [npm](https://www.npmjs.com/package/@screenshotmax/sdk):

```bash
npm install @screenshotmax/sdk
```

# Usage Examples

Use the SDK to generate signed or unsigned URLs for screenshots, PDFs, web scraping, or animated screenshot without executing the request. Or fetch and download the result directly. You have full control over when and how each capture runs.

The SDK also supports the Scheduled Tasks API, allowing you to queue captures to run at a later time or on a recurring schedule.

### Screenshot example

```typescript
import fs from "node:fs";
import { SDK } from "@screenshotmax/sdk";

// create API client 
const sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// set up options
sdk.screenshot.setOptions({
  url: "https://example.com",
  format: "png"
});

// optionally: generate signed URL
// (https://api.screenshotmax.com/v1/screenshot?url=https%3A%2F%2Fexample.com&format=png&access_key=YOUR_ACCESS_KEY&signature=370f5b161bc59eed13b76........1f778635d7fc595dbab12)
const url = sdk.screenshot.getUrl();

// generate screenshot
const result = await sdk.screenshot.fetch();

fs.writeFileSync("screenshot.png", Buffer.from(result.data, "binary"));
```

### PDF generation example

```typescript
import fs from "node:fs";
import { SDK } from "@screenshotmax/sdk";

// create API client 
const sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// set up options and scrape content (chaining)
const result = await sdk.pdf
  .setOptions({
    url: "https://example.com",
    pdf_paper_format: "letter",
  })
  .fetch();

// generate unsigned URL
// (https://api.screenshotmax.com/v1/pdf?&access_key=YOUR_ACCESS_KEY&url=https%3A%2F%2Fexample.com&pdf_paper_format=letter)
const url = sdk.pdf.getUrl(false);


fs.writeFileSync("pdf.pdf", Buffer.from(result.data, "binary"));
```

### Web scraping example

```typescript
import fs from "node:fs";
import { SDK } from "@screenshotmax/sdk";

// create API client 
const sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// set up options
sdk.scrape.setOptions({
  url: "https://example.com",
  format: "html",
});

const result = await sdk.scrape.fetch();

fs.writeFileSync("scrape.html", result.data);
```

### Scheduled task example

```typescript
import { SDK } from "@screenshotmax/sdk";

// create API client 
const sdk = new SDK("<ACCESS_KEY>", "<SECRET_KEY>");

// get all tasks from account
const tasks = await sdk.task.getTasks();
// {
//   tasks: [
//     {
//       id: 5678133109850112,
//       name: 'My cron test',
//       api: 'screenshot',
//       query: 'url=https%3A%2F%2Fexample.com',
//       frequency: 'every_day',
//       crontab: '25 13 * * *',
//       timezone: 'Etc/UTC',
//       enabled: true,
//       created: 1747229104,
//       last_run: 1748438712,
//       runs: 16
//     }
//   ]
// }
```

## Next Steps

* Explore other API options like HTML to PDF, animated screenshots, or web scraping.
* Create scheduled recurring screenshots via [**Scheduled Tasks API**](/guides/start/scheduled-tasks)

## Support

For questions, issues, or feature requests, please open an issue on the [GitHub repository](https://github.com/screenshotmax/typescript-sdk) or contact our support team at [support@screenshotmax.com](mailto:support@screenshotmax.com).


# PHP SDK
Source: https://docs.screenshotmax.com/guides/sdks/php

The ScreenshotMAX PHP SDK provides a streamlined interface for integrating ScreenshotMAX’s screenshot capabilities into your PHP applications. It simplifies tasks such as authentication, request signing, and interacting with the ScreenshotMAX API.

The SDK client stays up-to-date with the latest API capabilities.

# Getting Started

#### Install the SDK using [Composer](https://packagist.org/packages/screenshotmax/sdk/):

```bash
composer require screenshotmax/sdk
```

# Usage Examples

Use the SDK to generate signed or unsigned URLs for screenshots, PDFs, web scraping, or animated screenshot without executing the request. Or fetch and download the result directly. You have full control over when and how each capture runs.

The SDK also supports the Scheduled Tasks API, allowing you to queue captures to run at a later time or on a recurring schedule.

### Screenshot example

```php
<?php

use ScreenshotMax\SDK;
use ScreenshotMax\Options\ScreenshotOptions;

$sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// set up options
$opts = new ScreenshotOptions();
$opts->url = "https://example.com";
$opts->format = "png";
$result = $sdk->screenshot->setOptions($opts)->fetch();

// optionally: generate signed URL
// (https://api.screenshotmax.com/v1/screenshot?url=https%3A%2F%2Fexample.com&format=png&access_key=YOUR_ACCESS_KEY&signature=370f5b161bc59eed13b76........1f778635d7fc595dbab12)
$url = $sdk->screenshot->getUrl();

// save screenshot to file
file_put_contents("screenshot.png", $result["data"]);
```

### Web scraping example

```php
<?php

use ScreenshotMax\SDK;
use ScreenshotMax\Options\ScrapeOptions;

$sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// set up options and scrape content (chaining)
$opts = new ScrapeOptions();
$opts->url = 'https://example.com';
$sdk->scrape->setOptions($opts);

$result = $sdk->scrape->fetch();
```

### PDF generation example

```php
<?php

use ScreenshotMax\SDK;
use ScreenshotMax\Options\PDFOptions;

$sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// set up options and scrape content (chaining)
$opts = new PDFOptions();
$opts->url = 'https://example.com';
$opts->pdf_paper_format = 'a4';
$result = $sdk->pdf->setOptions($opts)->fetch();
```

### Scheduled task example

```php
<?php

use ScreenshotMax\SDK;

$sdk = new SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY");

// get all tasks from account
$tasks = $sdk->task->getTasks();
print_r($tasks["data"]);

/* {"tasks":[{
  "id":5678133109850112,
  "name":"Test CRON",
  "api":"screenshot",
  "query":
  "url=https%3A%2F%2Fexample.com",
  "frequency":"every_day",
  "crontab":"25 13 * * *",
  "timezone":"Etc/UTC",
  "enabled":true,
  "created":1747229104,
  "last_run":1748611516,
  "runs":18}]}
*/
```

## Next Steps

* Explore other API options like HTML to PDF, animated screenshots, or web scraping.
* Create scheduled recurring screenshots via [**Scheduled Tasks API**](/guides/start/scheduled-tasks)

## Support

For questions, issues, or feature requests, please open an issue on the [GitHub repository](https://github.com/screenshotmax/php-sdk) or contact our support team at [support@screenshotmax.com](mailto:support@screenshotmax.com).


# Python SDK
Source: https://docs.screenshotmax.com/guides/sdks/python

The ScreenshotMAX Python SDK provides a streamlined interface for integrating ScreenshotMAX’s screenshot capabilities into your Python applications. It simplifies tasks such as authentication, request signing, and interacting with the ScreenshotMAX API.

The SDK client stays up-to-date with the latest API capabilities.

# Getting Started

#### Install the SDK using [pip](https://pypi.org/project/screenshotmax/):

```bash
pip install screenshotmax
```

# Usage Examples

Use the SDK to generate signed or unsigned URLs for screenshots, PDFs, web scraping, or animated screenshot without executing the request. Or fetch and download the result directly. You have full control over when and how each capture runs.

The SDK also supports the Scheduled Tasks API, allowing you to queue captures to run at a later time or on a recurring schedule.

### Screenshot example

```python
from screenshotmax import SDK
from screenshotmax.enum import ImageFormat
from screenshotmax.options import ScreenshotOptions

sdk = SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY")

# set up options
opts = ScreenshotOptions(url="https://example.com", format=ImageFormat.PNG)
# fetch screenshot
result, headers = sdk.screenshot.set_options(opts).fetch()

# optionally: generate signed URL 
# (https://api.screenshotmax.com/v1/screenshot?url=https%3A%2F%2Fexample.com&format=png&access_key=YOUR_ACCESS_KEY&signature=370f5b161bc59eed13b76........1f778635d7fc595dbab12)
url = sdk.screenshot.get_url()

# save screenshot to file
with open("screenshot.png", "wb") as f:
  f.write(result)
```

### Web scraping example

```python
from screenshotmax import SDK
from screenshotmax.options import ScrapeOptions

sdk = SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY")

# set up options and scrape content (chaining)
opts = ScrapeOptions(url="https://example.com")
sdk.scrape.set_options(opts)

result, headers = sdk.scrape.fetch()
```

### PDF generation example

```python
from screenshotmax import SDK
from screenshotmax.enums import PDFPaperFormat
from screenshotmax.options import PDFOptions

sdk = SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY")

# set up options and scrape content (chaining)
opts = PDFOptions(url="https://example.com", pdf_paper_format=PDFPaperFormat.LETTER)
result, headers = sdk.pdf.set_options(opts).fetch()
```

### Scheduled task example

```python
from screenshotmax import SDK
from screenshotmax.options import PDFOptions

sdk = SDK("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY")

# get all tasks from account
tasks = sdk.task.get_tasks()
# {"tasks":[{
# "id":5678133109850112,
# "name":"Test CRON",
# "api":"screenshot",
# "query":
# "url=https%3A%2F%2Fexample.com",
# "frequency":"every_day",
# "crontab":"25 13 * * *",
# "timezone":"Etc/UTC",
# "enabled":true,
# "created":1747229104,
# "last_run":1748611516,
# "runs":18}]}
```

## Next Steps

* Explore other API options like HTML to PDF, animated screenshots, or web scraping.
* Create scheduled recurring screenshots via [**Scheduled Tasks API**](/guides/start/scheduled-tasks)

## Support

For questions, issues, or feature requests, please open an issue on the [GitHub repository](https://github.com/screenshotmax/python-sdk) or contact our support team at [support@screenshotmax.com](mailto:support@screenshotmax.com).


# Animated Screenshots
Source: https://docs.screenshotmax.com/guides/start/animated-screenshots

The screencast endpoint lets you generate short video captures of your webpage — either as a static animation (video) or a dynamic scroll-through (scroll). It’s great for showcasing your app, previewing a website, or generating media content programmatically.

<Warning>
  **Plan Availability**

  Available on **Growth and Scale plans**.
  Also available in test mode with the **Free** plan.
</Warning>

## Use Case Examples

* Demo your app’s onboarding flow
* Capture animation effects or video players
* Scroll through an entire product page for marketing
* Generate reels or preview clips for social media

## API Parameters

### Optional Parameters

**format**

* Type: string
* Allowed: `webm`, `mp4`, `mov`, `avi`
* Default: `mp4`
* Description: The video output format. `mp4` is widely supported and recommended for general use.

**duration**

* Type: integer
* Range: `1` to `30` seconds
* Default: `5`
* Description: The total duration of the recording. Longer durations are useful for full scrolls or animations.

**scenario**

* Type: string
* Options: `video`, `scroll`
* Default: `video`
* Description:
  * `video`: A static screen recording, useful for animations, transitions, or video players.
  * `scroll`: Automatically scrolls the page down during recording, ideal for long-form content like blog posts.

#### Scrolling-Specific Options

(Only used when scenario is `scroll`)

**scroll\_by\_amount**

* Type: integer
* Default: `1000`
* Description: Number of pixels to scroll per step.

**scroll\_by\_delay**

* Type: integer (ms)
* Default: `500`
* Description: Time to wait between each scroll step.

**scroll\_by\_duration**

* Type: integer (ms)
* Default: `1500`
* Description: Duration of the scroll animation itself (smooth scroll).

**scroll\_back**

* Type: boolean
* Default: `true`
* Description: If enabled, the page scrolls back up to the top at the end.

**scroll\_back\_delay**

* Type: integer (ms)
* Default: `800`
* Description: Time to wait before starting the scroll-back animation.

**scroll\_easing**

* Type: string
* Default: `linear`
* Description: Easing function applied to scrolling animations. Controls the smoothness and acceleration.

### How the scroll scenario works

When using scenario `scroll` option, the animation simulates a natural reading or browsing experience:

1. The page scrolls down by `scroll_by_amount` pixels.
2. After each scroll, it pauses for `scroll_by_delay` milliseconds.
3. Each scroll movement is animated over `scroll_by_duration` milliseconds for smoothness.
4. This process repeats step-by-step until the bottom of the page is reached.
5. If `scroll_back` is set to true, the page will pause for `scroll_back_delay` milliseconds, then scroll back to the top in one smooth motion.

This gives the impression of a user reading or exploring the page in a relaxed and controlled way — perfect for demos, tutorials, and showcase clips.

#### Making Scrolls Feel Natural with `scroll_easing` parameter

The `scroll_easing` parameter is a powerful tool for controlling the feel of your scroll animations.,It allows you to choose how the scrolling motion behaves, making it more or less dynamic depending on your needs.
The `scroll_easing` parameter affects each scroll step in the `scroll` scenario, giving you fine control over the pacing and fluidity of the motion.

**Why Easing Matters**

A scroll that moves linearly feels robotic. Easing functions allow for acceleration and deceleration, creating a more human-like experience.

**Available Easing Options**

| Easing               | Description                                                                                     |
| -------------------- | ----------------------------------------------------------------------------------------------- |
| linear               | Constant speed from start to end. Feels mechanical. Good for technical demos or precise timing. |
| ease\_in\_quad       | Starts slow, speeds up. Feels like someone starting to scroll carefully, then accelerating.     |
| ease\_out\_quad      | Starts fast, slows down. Great for attention-grabbing stops.                                    |
| ease\_in\_out\_quad  | Starts slow, speeds up, then slows down. Very natural. Ideal for most use cases.                |
| ease\_in\_cubic      | Slower start with more punchy acceleration. A bit more dramatic than quad.                      |
| ease\_out\_cubic     | Strong start, smooth slow-down. Nice for relaxing endings.                                      |
| ease\_in\_out\_cubic | Smooth acceleration and deceleration. Balanced and elegant.                                     |
| ease\_in\_quart      | Very slow start, then rapid. Great if you want dramatic build-up.                               |
| ease\_out\_quart     | Fast start, very soft landing. Feels like gliding in.                                           |
| ease\_in\_out\_quart | Cinema-style. High control with graceful motion.                                                |
| ease\_in\_quint      | Extremely slow start and rapid acceleration. For stylized scrolls.                              |
| ease\_out\_quint     | Fast drop, featherlight finish. Perfect for premium UIs.                                        |
| ease\_in\_out\_quint | Ultra-smooth and polished - high-end product demo feel.                                         |

Need help? Contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com)


# Async and Webhooks
Source: https://docs.screenshotmax.com/guides/start/async-webhooks

For long-running or high-volume tasks, you can choose to receive the result asynchronously via a webhook.

# Sending a Webhook

## How It Works

Instead of waiting for the result in the API response, you can provide a webhook\_url in your request. Once the rendering is complete, we will send a POST request to that URL with the result.

Your `webhook_url` must:

* Be publicly accessible over HTTPS or HTTP
* Accept POST requests
* Return a 2xx HTTP status code to acknowledge the event

## Request Parameters

| Parameter        | Type   | Description                                                          |
| ---------------- | ------ | -------------------------------------------------------------------- |
| `webhook_url`    | string | The URL to which the webhook will be sent.                           |
| `webhook_signed` | bool   | If true, the webhook payload will be signed using your `secret_key`. |

### Webhook Signature (Optional but recommended)

If `webhook_signed` is set to true, we include a signature in the webhook request header:

```
X-Screenshotmax-WebHook-Signature: <sha256_hmac_signature>
```

This signature is generated using the HMAC SHA256 algorithm with your `secret_key` and the payload. You can verify the signature to ensure the request is from us.

### How to Verify the Signature

To verify the signature on your server:

1. Serialize the exact raw JSON body of the request.
2. Compute the HMAC SHA-256 hash using your `secret_key`.
3. Compare your computed hash with the value in the `X-Screenshotmax-WebHook-Signature` header.

<Warning>Be sure to use the raw body (as a string) before any parsing.</Warning>

## Webhook Payload

```json
{
  "id": "id-of-request",
  "file": "https://cache.screenshotmax.com/<hash>.<ext>",
  "expires": 1722625200,
  "created": 1716898800
}
```

| Field     | Type   | Description                                              |
| --------- | ------ | -------------------------------------------------------- |
| `id`      | string | The unique identifier for the request.                   |
| `file`    | string | The URL to the generated file.                           |
| `expires` | number | The timestamp (in seconds) when the file will expire.    |
| `created` | number | The timestamp (in seconds) when the request was created. |

**Example API Request**

```json
POST https://api.screenshotmax.com/v1/screenshot
{
  "url": "https://example.com",
  "access_key": "YOUR_ACCESS_KEY",
  "webhook_url": "https://yourserver.com/webhook-handler",
  "webhook_signed": true
}
```

### Tips for Testing

* Use [Webhook.site](https://webhook.site) to inspect incoming payloads
* Use [ngrok](https://ngrok.com/) to expose local endpoints for testing

# Async Request

If you don’t want to wait for the rendering result immediately in the response, you can process the request in **asynchronous mode** by setting the `async` parameter to true.

## What Happens in Async Mode?

When you set `async` to true in your request:

* The API **immediately responds with a 202 Accepted**.
* The rendering job is queued and processed in the background.

Once complete, the result is:

* Visible in your dashboard under the [Requests section](https://app.screenshotmax.com/requests).
* Optionally delivered to your `webhook_url`, if provided.

## How to Use

Add the `async` parameter to your request (either GET or POST):

**POST Example**

```json
POST https://api.screenshotmax.com/v1/screenshot
{
  "url": "https://example.com",
  "access_key": "YOUR_ACCESS_KEY",
  "async": true
}
```

**GET Example**

```
GET https://api.screenshotmax.com/v1/screenshot?url=https://example.com&access_key=YOUR_ACCESS_KEY&async=true
```

## API Response

When you set `async` to true, the API will respond with a 202 Accepted status code. The response will look like this:

```json
{
  "status": "Accepted",
  "message": "The request has been accepted for processing",
  "created": 1744030537
}
```

## Tracking the Result

After submission, the job will appear in your Requests dashboard. You can:

* View status (done, failed)
* Download the result once complete

If you included a `webhook_url`, you will also receive the result automatically once ready

Need help? Contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com)


# Authentication
Source: https://docs.screenshotmax.com/guides/start/authentication

Learn how to authenticate your requests to the ScreenshotMAX API using your unique API access key. This guide covers the authentication process for both GET and POST requests, ensuring secure and efficient access to our services.

To use our API, you’ll need an `access_key`. This key is **unique to your account** and is required for **all API requests.**

## What is the Access Key?

The `access_key` identifies and authenticates your requests. Think of it as your personal API password. Without it, the API will reject your requests.

<Warning>Never share your access key publicly or commit it to version control.</Warning>

## How to use the Access Key

You can authenticate your requests in one of the following ways:

### 1. In the Header (Recommended)

Add the access key to the `X-Access-Key` HTTP header. This method is secure and works with **all HTTP methods.**

```json
X-Access-Key: YOUR_ACCESS_KEY
```

### 2. In the Query String (GET requests only)

For GET requests, you can include the key as a query parameter:

```
GET https://api.screenshotmax.com/v1/screenshot?access_key=YOUR_ACCESS_KEY&url=https://example.com
```

This is useful for quick testing or browser-based usage.

### 3. In the JSON Body (POST requests only)

For POST requests, you can also include the key in the request body:

```json
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}
```

### Example Requests

Example using curl (Header)

```bash
curl -X GET https://api.screenshotmax.com/v1/screenshot \
  -H "X-Access-Key: YOUR_ACCESS_KEY" \
  -G --data-urlencode "url=https://example.com"
```

Example using fetch (POST)

```js
fetch("https://api.screenshotmax.com/v1/pdf", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Access-Key": "YOUR_ACCESS_KEY"
  },
  body: JSON.stringify({
    url: "https://example.com"
  })
});
```

## Rotating Your Access Key

You can regenerate (rotate) your access key at any time from your [dashboard](https://app.screenshotmax.com/access).
When you rotate your key:

* A **new access key** is generated immediately.
* Your **old key becomes invalid** and cannot be used anymore.

<Warning>Be sure to update your access key in all scripts and environments after rotation.</Warning>

### What happens if the access key is missing or invalid?

If your request doesn’t include a valid `access_key`, you’ll receive a status 401 and a response like this:

```json
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid access key"
}
```

This means your request was rejected due to authentication failure. Double-check your access key and try again.

Need help? Contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com)


# GPU Rendering
Source: https://docs.screenshotmax.com/guides/start/gpu-rendering

Enable lightning-fast and high-fidelity rendering using GPU acceleration.

## What is GPU Rendering?

GPU rendering leverages hardware acceleration to generate screenshots and PDFs more efficiently, especially for complex or animated content. This feature is ideal for:

* Heavy web animations
* WebGL / 3D visualizations
* Video rendering previews
* Graphically rich UIs

## Plan Requirement

<Warning>GPU rendering is only available to users on the **Scale plan**.</Warning>

If you’re on the Free, Basic or Growth plans, enabling `gpu_rendering` will return the status 423 and an error:

```json
{
  "statusCode": 423,
  "error": "Locked",
  "message": "No quota. Please subscribe to a paid plan with gpu rendering capabilities"
}
```

You can upgrade your plan anytime from the Subscribe section of your [dashboard](https://app.screenshotmax.com/subscribe/monthly).

## How to Enable GPU Rendering

To activate GPU rendering, simply set the `gpu_rendering` option to true in your API request.

Example (POST request)

```json
{
  "url": "https://example.com",
  "access_key": "YOUR_ACCESS_KEY",
  "gpu_rendering": true
}
```

Example (GET request)

```
GET https://api.screenshotmax.com/v1/screenshot
?url=https://example.com
&access_key=YOUR_ACCESS_KEY
&gpu_rendering=true
```

The `gpu_rendering` flag is optional and defaults to false.

### Need Help?

If you’re unsure whether you need GPU rendering or how to upgrade your plan, contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com)


# Introduction
Source: https://docs.screenshotmax.com/guides/start/introduction

Welcome to the ScreenshotMAX API. This guide will help you quickly integrate our API into your project. Whether you need to capture screenshots, record animated screenshots, generate PDFs, or scrape webpage content, our API offers a simple and flexible solution using both GET and POST requests.

## Prerequisites

Before you begin, ensure you have:

* **API Access Key:** Obtain your unique access key by signing up on our platform.
* **Basic HTTP & JSON Knowledge:** Familiarity with making HTTP requests and handling JSON data.
* **Development Environment:** Any environment capable of sending HTTP requests (e.g., cURL, Postman, or your preferred programming language).

## API Endpoints

Our API provides four primary endpoints. Each endpoint supports both GET and POST methods:

<CardGroup cols={2}>
  <Card title="/screenshot" icon="aperture" iconType="duotone" href="/endpoints/get-screenshot">
    Capture high-quality webpage screenshots
  </Card>

  <Card title="/screencast" icon="film" iconType="duotone" href="/endpoints/get-screencast">
    Record animated screenshots of webpages.
  </Card>

  <Card title="/pdf" icon="file-pdf" iconType="duotone" href="/endpoints/get-pdf">
    Generate PDFs from webpages.
  </Card>

  <Card title="/scrape" icon="file-import" iconType="duotone" href="/endpoints/get-scrape">
    Scrape content from webpages.
  </Card>

  <Card title="/tasks" icon="timer" iconType="duotone" href="/endpoints/get-tasks">
    Automate your actions.
  </Card>

  <Card title="/others" icon="gear-code" iconType="duotone" href="/endpoints/usage">
    Usage and devices list.
  </Card>
</CardGroup>


# IP Ranges
Source: https://docs.screenshotmax.com/guides/start/ip-ranges

List of IP ranges used by ScreenshotMAX API infrastructure.

To enable access from the **ScreenshotMAX API** to your infrastructure, please ensure your firewall allows traffic from the following IP addresses:

* **Google Cloud `us-central1` region IPs**.
  Refer to the official [Google Cloud IP ranges](https://www.gstatic.com/ipranges/cloud.json) for the most up-to-date list.

If your setup requires additional configuration or you encounter issues, please contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com) for assistance.


# Quickstart
Source: https://docs.screenshotmax.com/guides/start/quickstart

Making your first request

## GET Request Example

Use a GET request when you prefer to pass parameters via querystrings. For example, to capture a screenshot:

```
https://api.screenshotmax.com/v1/screenshot
?access_key=YOUR_ACCESS_KEY
&url=https://example.com
```

## POST Request Example

For POST requests, you send a JSON payload. Here’s an example for capturing an animated screenshot:

```json
POST "https://api.screenshotmax.com/v1/screenshot"
{
  "access_key": "YOUR_ACCESS_KEY",
  "url": "https://example.com"
}
```

## Request Parameters Overview

All endpoints require the following basic parameters:

* **`access_key`** (string): Your unique API key. **(required)**
* **`url`** (string): The target webpage URL. **(required)**

Additional parameters allow you to customize your requests (e.g., viewport settings, delay, caching, and more).
For a full list of parameters and their constraints, please refer to our [API References](https://docs.screenshotmax.com/endpoints/get-screenshot).

## Handling API Responses

The API returns responses that include your captured media (screenshot, animated screenshot, PDF, or scraped content) along with relevant metadata (such as HTTP status, headers, and additional capture details).


# Scheduled Tasks
Source: https://docs.screenshotmax.com/guides/start/scheduled-tasks

Scheduled Tasks allow you to automatically trigger API calls at regular intervals, without any manual action. Perfect for automation, monitoring, and recurring data capture.

<Warning>
  **Plan Requirement**

  Scheduled Tasks are available only on the **Scale plan**.
  Upgrade your account via the Subscription / Dashboard [section](https://app.screenshotmax.com/subscribe/monthly) to unlock this feature.
</Warning>

## Managing Scheduled Tasks

You can manage scheduled tasks directly from your [Dashboard](https://app.screenshotmax.com/scheduled-tasks):

* Create new tasks
* Edit existing ones
* Delete tasks
* Pause or resume individual tasks

## Configuration Parameters

| Field       | Description                                                                                                                       |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Name        | The name of the scheduled task.                                                                                                   |
| Service     | Which API to call: **screenshot, screencast, pdf, or scrape**.                                                                    |
| Querystring | The query string to send with the API call (must be URL-encoded).                                                                 |
| Frequency   | How often the task runs: Every minute - Every hour - Every day - Every month - Custom: use standard cron syntax (\* \* \* \* \*). |
| Timezone    | Choose the timezone in which the task will be scheduled. Default to UTC.                                                          |
| Enabled     | Toggle to pause/resume the scheduled task without deleting it.                                                                    |

<Note>
  If your `access_key` is rotated, all scheduled tasks are automatically updated to use the new key.\
  If your account has **signed request mode** enabled, each scheduled request will be automatically signed with your `secret_key`.
</Note>

### Frequency Options

* **Every minutes**: Runs every minute
* **Every hours**: Runs every hour
* **Every days**: Runs every day at the same time
* **Every months**: Runs every month on the same day
* **Custom**: Runs at a custom interval. You can specify the exact time and frequency using standard cron syntax. For example, `0 0 * * *` runs every day at midnight, while `*/5 * * * *` runs every 5 minutes.
  Use [Unix Cron Format](https://crontab-generator.com/en).

### Timezone Options

Select the timezone in which the task will be scheduled. This is important for tasks that need to run at specific times, such as daily reports or hourly checks.
The value must correspond to the timezone abbreviation used in the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). The default timezone is UTC.

## Under the Hood

Each scheduled task is equivalent to a standard API request. When it runs, it:

* Calls the corresponding API with your configured query parameters
* Triggers your webhook if one is set
* Appears in your Request Logs for tracking and debugging

## Example Use Cases

* Capture a daily screenshot of your homepage
* Run a scrape job every hour to monitor price changes
* Generate a PDF of a report every Monday at 6am
* Monitor the availability of a service in a specific timezone

Need help? Contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com)


# Signed Requests
Source: https://docs.screenshotmax.com/guides/start/signed-requests

Generate signed requests for secure communication with ScreenshotMAX API

For additional security, you can authenticate GET requests using a **signed querystring**. This method ensures that the request has not been tampered with and comes from a trusted source.

<Warning>Signed requests are only supported for **GET requests.**</Warning>

## What is a Signed Request?

A signed request uses your **secret key** to generate a SHA-256 hash of the querystring. This hash is then included in the request as a signature parameter.
When our servers receive the request, they verify the signature using the same secret key.

## Your Secret Key

* Your `secret_key` is **unique to your account**.
* It is **only visible in your dashboard**.
* **Never share your secret key publicly**.
* You can **rotate your secret key** at any time via the dashboard.

<Warning>If your secret key is exposed or compromised, rotate it immediately.</Warning>

## Enforce Signed GET Requests

From your dashboard, you can enforce signature validation for all GET requests by enabling the option:
**“Accept only signed requests”**

Once enabled:

* Any unsigned GET request will be rejected.
* This setting does **not** affect POST or other non-GET requests.
* You can toggle this option from the Access Control Management section in your [dashboard](https://app.screenshotmax.com/access).

## How to Sign a Request

### 1. Start with your full querystring (everything after the ?)

Example of querystring:

```
url=https://example.com&access_key=YOUR_ACCESS_KEY
```

### 2. Do not include the signature parameter (yet)!

### 3. Compute the SHA-256 HMAC of the querystring using your `secret_key`

Node.js Example

```js
const crypto = require("crypto");

const queryString = "url=https://example.com&access_key=YOUR_ACCESS_KEY";
const secretKey = "YOUR_SECRET_KEY";

const signature = crypto
  .createHmac("sha256", secretKey)
  .update(queryString)
  .digest("hex");

console.log(signature);
```

Python Example

```python
import hmac
import hashlib

query_string = "url=https://example.com&access_key=YOUR_ACCESS_KEY"
secret_key = b"YOUR_SECRET_KEY"  # must be bytes

signature = hmac.new(secret_key, query_string.encode("utf-8"), hashlib.sha256).hexdigest()

print(signature)
```

### 4. Add the signature parameter to your final querystring

```
?url=https://example.com&access_key=YOUR_ACCESS_KEY&signature=computed_signature
```

## Rotating the Secret Key

Just like the `access_key`, you can rotate your `secret_key` from your dashboard.
After rotation:

* A new secret key will be generated.
* The old one will become invalid.
* Make sure to update all your signing logic with the new key.

Example (Full URL)

```
GET https://api.screenshotmax.com/v1/screenshot
?url=https://example.com
&access_key=YOUR_ACCESS_KEY
&signature=2f3a5c9d...
```

<Warning>
  #### Important Notes

  * The **order** of query parameters must be **preserved** exactly when generating the signature.
  * **Do not include the signature parameter itself** in the string you hash.
  * Only use this method for **GET** requests. It is not supported for POST or other methods.
</Warning>

## Test Your Signature

We recommend verifying your implementation in a development environment before going live.

## Why Use Signed Requests?

Signed requests add an extra layer of protection, ensuring:

* The request hasn’t been modified in transit.
* The request originates from a trusted client with access to the secret key.
* You can optionally enforce this behavior for all GET calls to your API.

Need help? Contact us at [support@screenshotmax.com](mailto:support@screenshotmax.com)


# null
Source: https://docs.screenshotmax.com/guides/tutorials/captchas





# null
Source: https://docs.screenshotmax.com/guides/tutorials/performance





# null
Source: https://docs.screenshotmax.com/guides/tutorials/proxies