SearchCtrl+K

Bulk Screenshot API Reference

Capture screenshots of up to 50 URLs in a single POST request. Each URL can have its own screenshot settings - format, dimensions, CSS/JS injection, ad blocking, and more. Returns individual screenshot URLs per submitted URL.

POSThttps://api.apifreaks.com/v1.0/screenshot

Test

Send a JSON body with a urls array. Each item in the array is an object containing a url and any optional screenshot parameters (same options as the single Screenshot API). The API key is passed via the X-apiKey header.

Getting Started

Authentication

Pass your API key as the X-apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl -X 'POST' \
  'https://api.apifreaks.com/v1.0/screenshot' \
  -H 'Content-Type: application/json' \
  -H 'X-apiKey: API-KEY' \
  -d '{
  "urls": [
    {
      "url": "https://whoisfreaks.com/",
      "file_type": "gif",
      "width": 3840,
      "height": 2160,
      "fresh": true,
      "image_quality": 100,
      "scrolling_screenshot": true,
      "duration": 10
    }
  ]
}'

Response

{
  "status": "success",
  "meta_data": {
    "total_urls": 1,
    "successful_urls": 1,
    "failed_urls": 0
  },
  "results": [
    {
      "url": {
        "screenshot": "https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/whoisfreaks_com__a34071f0e507.gif",
        "url": "https://whoisfreaks.com/",
        "created_at": "2026-06-15T17: 59: 10.306Z",
        "file_type": "gif",
        "width": 3840,
        "height": 2160,
        "fresh": true,
        "image_quality": 100,
        "scrolling_screenshot": true,
        "duration": 10,
        "output": "json",
        "ttl": "2026-07-15T17: 58: 43.853Z",
        "sizes": null
      },
      "status": "fulfilled",
      "error_message": null
    }
  ]
}

API Request

Optional query parameters that control the bulk API response format.

Query Parameters

formatoptionalStringdefault: json

Response format: 'json' (default) or 'xml'.

Request Body

The request body is a JSON object with a urls array. Each item requires a url field and supports all optional parameters from the single Website Screenshot API - file type, dimensions, dark mode, ad blocking, custom CSS/JS, and more. View all supported parameters

{
  "urls": [
    {
      "url": "https://whoisfreaks.com/",
      "file_type": "gif",
      "width": 3840,
      "height": 2160,
      "fresh": true,
      "image_quality": 100,
      "scrolling_screenshot": true,
      "duration": 10
    }
  ]
}

Request Body Parameters

Each object in the urls array accepts the following parameters. Only url is required - all others are optional.

formatoptionalStringdefault: json

Response format: 'json'.

urlrequiredString

URL of the website to be rendered as a screenshot or other format.

file_typeoptionalStringdefault: PNG

Output format. PNG (lossless, transparency), JPEG (compressed, smaller size), WebP (modern, efficient), PDF (document). For scrolling captures: MP4, GIF, WebM. Default: PNG.

omit_backgroundoptionalBooleandefault: false

Replaces simple white/plain backgrounds with transparency for a cut-out effect. Only works with PNG output. Default: false.

destroy_screenshotoptionalBooleandefault: false

If true, screenshot/PDF is not stored on server and must be downloaded immediately. Default: false.

fail_on_erroroptionalBooleandefault: false

If true, returns an error when the target page responds with 4xx or 5xx status. Default: false.

longitudeoptionalFloat

Specify longitude for the browser Geolocation API. Provide a numeric value. Default: null (not set).

latitudeoptionalFloat

Specify latitude for the browser Geolocation API. Provide a numeric value. Default: null (not set).

proxyoptionalString

Allows defining a proxy for the connection. Provide a JSON string with keys: server (include port number), username, and password.

no_cookie_bannersoptionalBooleandefault: false

Hides or blocks cookie consent banners and popups before capture. Default: false.

block_adsoptionalBooleandefault: false

Blocks requests to known ad networks for cleaner, distraction-free screenshots. Default: false.

headersoptionalString

Custom HTTP headers to include as key=value pairs. Use a semicolon to separate multiple headers (e.g., key1=value1;key2=value2).

cookiesoptionalStringdefault:

Cookies to include in the request before rendering. Supports single or multiple cookies. Example: cookie=value; otherCookie=otherValue;

scroll_to_elementoptionalStringdefault:

Scrolls the page to bring the specified CSS selector into view before capture. Ideal for below-the-fold content. Default: empty.

selectoroptionalStringdefault:

CSS selector to capture a specific element. Only that element is rendered. Falls back to full page if not found. Default: empty.

selector_to_clickoptionalStringdefault:

CSS selector for an element to click before capturing the screenshot. Useful for opening dropdowns, modals, or triggering content.

click_recursionoptionalIntegerdefault: 1

Number of times to click the selector (when set via selector_to_click). Default: 1.

blur_selectoroptionalStringdefault:

CSS selectors to blur before capture. Masks sensitive data like emails, payments, or personal info. Multiple selectors supported. Default: empty.

remove_selectoroptionalStringdefault:

CSS selectors to remove before capture. Deletes matched elements from DOM. Ideal for cleaning ads, popups, sidebars. Multiple selectors supported. Default: empty.

cssoptionalStringdefault:

Allows injecting custom CSS code into the page before rendering. Pass the CSS code directly as a string.

css_urloptionalStringdefault:

Allows loading external CSS into the page. Provide a URL pointing to the CSS file.

jsoptionalStringdefault:

Allows injecting custom JavaScript code into the page before rendering. Pass the JavaScript code directly as a string.

js_urloptionalStringdefault:

Allows loading external JavaScript into the page. Provide a URL pointing to the script file.

ttloptionalIntegerdefault: 2592000

Time in seconds the render stays cached before auto-invalidation. Use higher values for static pages, lower for dynamic content. Default: 2592000 (30 days).

user_agentoptionalStringdefault:

Custom User-Agent string sent in the request headers.

accept_languagesoptionalStringdefault: en-US,en;q=0.8

Sets the accepted languages for the HTTP request. This is sent as the Accept-Language header.

delayoptionalIntegerdefault: 0

Wait period in milliseconds before capture. Allows animations, API responses, and dynamic elements to finish rendering. Default: 0.

thumbnail_widthoptionalInteger

Specifies the width of the thumbnail in pixels. Default value is 0 (meaning no specific value is set, and the screenshot is returned at its original resolution).

outputoptionalStringdefault: json

Set the output format. 'json' returns metadata with a hosted file URL. 'image' streams the raw file bytes directly. Default: json.

freshoptionalBooleandefault: true

If true, bypasses cache and captures a fresh render. If false, returns cached version when available. Default: true.

enable_cachingoptionalBooleandefault: false

Stores the render in cache for reuse on subsequent identical requests. Default: false.

lazy_loadoptionalBooleandefault: false

Automatically scrolls the page to trigger lazy-loaded images and components. Ensures complete content capture. Default: false.

scroll_delayoptionalIntegerdefault: 500

Delay in milliseconds between scroll steps when lazy_load is enabled. Use higher values for heavy pages. Default: 500.

full_pageoptionalBooleandefault: false

Captures the entire webpage from top to bottom, including scrollable content outside the viewport. Ideal for long-form pages. Default: false.

retinaoptionalBooleandefault: false

Captures at 2x resolution for sharper, high-DPI output. Increases file size. Default: false.

heightoptionalIntegerdefault: 867

Viewport height in pixels. Controls how much vertical area is visible. Max: 4320. Default: 867.

widthoptionalIntegerdefault: 1680

Viewport width in pixels. Simulates device screen sizes. Max: 7680. Default: 1680.

custom_htmloptionalStringdefault:

Custom HTML to render instead of loading a URL. Overrides the url option. Use for capturing specific HTML structures or dynamic content.

block_chat_widgetsoptionalBooleandefault: false

Blocks live chat popups, support bubbles, and messaging interfaces. Default: false.

block_jsoptionalBooleandefault: false

Disables all JavaScript execution. Renders a static version of the page. Speeds up capture but may break dynamic content. Default: false.

block_stylesheetsoptionalBooleandefault: false

Blocks all stylesheets - page renders as raw HTML without visual formatting. Default: false.

block_imagesoptionalBooleandefault: false

Blocks all image resources (jpg, png, gif, webp, svg, etc.) for faster rendering. Default: false.

block_mediaoptionalBooleandefault: false

Blocks audio and video resources (mp3, mp4, webm, etc.) from loading. Default: false.

block_fontoptionalBooleandefault: false

Blocks external font files - page falls back to system defaults. Supported: woff, woff2, ttf, otf, eot. Default: false.

block_text_trackoptionalBooleandefault: false

Blocks subtitles and caption overlays from loading. Default: false.

block_xhroptionalBooleandefault: false

Blocks all XMLHttpRequest (AJAX) calls - prevents dynamic API-driven content. Default: false.

block_fetchoptionalBooleandefault: false

Blocks all Fetch API requests - stops async data loading. Default: false.

block_event_sourceoptionalBooleandefault: false

Blocks EventSource (SSE) connections - prevents real-time data streams. Default: false.

block_web_socketoptionalBooleandefault: false

Blocks WebSocket connections - prevents real-time bidirectional communication. Default: false.

block_manifestoptionalBooleandefault: false

Blocks manifest files (.json, .webmanifest) - disables PWA-related functionality. Default: false.

block_specific_requestsoptionalStringdefault:

Fine-grained blocking of specific URLs or patterns. Separate multiple rules by comma, space, or newline. Default: empty.

adjust_topoptionalIntegerdefault: 0

Initial vertical scroll position in pixels before capture. Use to position mid-page content in viewport. Not supported for PDF. Default: 0.

image_qualityoptionalIntegerdefault: 80

Compression level for JPEG output (0-100). Lower = smaller file, higher = better quality. Only applies to JPEG. Default: 80.

extract_htmloptionalBooleandefault: false

Returns rendered HTML as a .html file (includes JS-executed DOM). Only available with output=json. Default: false.

extract_markdownoptionalBooleandefault: false

Extracts rendered page content as a structured .md (Markdown) file. Preserves headings, lists, links. Only with output=json. Default: false.

get_image_urlsoptionalBooleandefault: false

Extracts all image URLs from the rendered DOM and returns them in structured format. Only with output=json. Default: false.

extract_textoptionalBooleandefault: false

Strips all HTML and returns visible text as a .txt file. Ideal for text analysis, indexing, or AI pipelines. Only with output=json. Default: false.

dark_modeoptionalBooleandefault: false

When set to true, websites that support prefers-color-scheme: dark will render in dark mode. Default value is false.

block_trackingoptionalBooleandefault: false

Blocks tracking scripts and analytics services for cleaner, privacy-oriented renders. Default: false.

wait_for_eventoptionalStringdefault: load

Controls when rendering starts based on page load lifecycle. 'load' (all resources), 'domcontentloaded' (HTML parsed), 'networkidle' (no network activity for 500ms). Default: load.

grayscaleoptionalIntegerdefault: 0

Applies a grayscale filter to the screenshot. Requires a value from 0 (no effect) to 100 (fully grayscale). Default value is 0.

clip[x]optionalInteger

X coordinate (in pixels) for the top-left corner of the clip area. Default: null.

clip[y]optionalInteger

Y coordinate (in pixels) for the top-left corner of the clip area. Default: null.

clip[width]optionalInteger

Width of the clip area in pixels. Default: null.

clip[height]optionalInteger

Height of the clip area in pixels. Default: null.

result_file_nameoptionalStringdefault:

Custom name for the output file. Helps with organized storage and retrieval. Note: non-unique names may overwrite existing files.

enable_incognitooptionalBooleandefault: false

Enables private/incognito browsing. Each render starts with a clean slate - no cookies, cache, or session data persisted. Default: false.

timeoutoptionalIntegerdefault: 100000

Maximum wait in milliseconds for page load before aborting. Adjust for slow/heavy pages. Default: 100000 (100s).

Scrolling Screenshot Parameters

Use these additional parameters when capturing scrolling screenshots as a video. Set scrolling_screenshot=true on any URL in the batch to enable scrolling capture mode.

Scrolling captures can be exported in multiple video formats. Use the file_type parameter to choose the output format:webm, mp4, or gif.

Example:scrolling_screenshot=true&file_type=mp4will generate an MP4 video of the page being automatically scrolled from top to bottom.

scrolling_screenshotoptionalBooleandefault: false

Enables scrolling screenshot mode to capture a video (webm, gif, mp4) of the webpage.

file_typeoptionalStringdefault: MP4

Output format for scrolling capture. Options: WEBM (web-optimized), MP4 (widely compatible), GIF (short loops). Default: MP4.

scroll_speedoptionalStringdefault: normal

Scrolling speed: fast, normal, or slow. Affects render time and output pacing. Default: normal.

durationoptionalInteger

Duration of scrolling action in seconds (0-60). Higher = longer video. Default: null (full page scroll).

scroll_backoptionalBooleandefault: false

If true, scrolls to bottom then back to top, creating a seamless loop. Default: false.

start_immediatelyoptionalBooleandefault: false

Starts recording immediately without waiting for full page load. Default: false.

videooptionalBooleandefault: false

Records visible viewport only for a specified duration. Use with duration parameter. Ideal for dashboards and animations. Default: false.

API Response Schema

A successful request returns a 200 OK with a JSON object containing a status string, metadata summary, and a results array with one entry per submitted URL.

status

Stringmandatory

API request status indicator. "success" for successful requests.

total_urls (Integer), successful_urls (Integer), failed_urls (Integer)

status (String), error_message (String | null), url (Object)

Error Status & Codes

See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.

400

Please provide data in required format in request body

413

Maximum request body size limit exceeded

Bulk Screenshot API Reference

POSThttps://api.apifreaks.com/v1.0/screenshot

Test

Getting Started

Authentication

Pass your API key as the X-apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl -X 'POST' \
  'https://api.apifreaks.com/v1.0/screenshot' \
  -H 'Content-Type: application/json' \
  -H 'X-apiKey: API-KEY' \
  -d '{
  "urls": [
    {
      "url": "https://whoisfreaks.com/",
      "file_type": "gif",
      "width": 3840,
      "height": 2160,
      "fresh": true,
      "image_quality": 100,
      "scrolling_screenshot": true,
      "duration": 10
    }
  ]
}'

Response

{
  "status": "success",
  "meta_data": {
    "total_urls": 1,
    "successful_urls": 1,
    "failed_urls": 0
  },
  "results": [
    {
      "url": {
        "screenshot": "https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/whoisfreaks_com__a34071f0e507.gif",
        "url": "https://whoisfreaks.com/",
        "created_at": "2026-06-15T17: 59: 10.306Z",
        "file_type": "gif",
        "width": 3840,
        "height": 2160,
        "fresh": true,
        "image_quality": 100,
        "scrolling_screenshot": true,
        "duration": 10,
        "output": "json",
        "ttl": "2026-07-15T17: 58: 43.853Z",
        "sizes": null
      },
      "status": "fulfilled",
      "error_message": null
    }
  ]
}

API Request

Optional query parameters that control the bulk API response format.

Query Parameters

formatoptionalStringdefault: json

Response format: 'json' (default) or 'xml'.

Request Body

{
  "urls": [
    {
      "url": "https://whoisfreaks.com/",
      "file_type": "gif",
      "width": 3840,
      "height": 2160,
      "fresh": true,
      "image_quality": 100,
      "scrolling_screenshot": true,
      "duration": 10
    }
  ]
}

Request Body Parameters

Each object in the urls array accepts the following parameters. Only url is required - all others are optional.

formatoptionalStringdefault: json

Response format: 'json'.

urlrequiredString

URL of the website to be rendered as a screenshot or other format.

file_typeoptionalStringdefault: PNG

Output format. PNG (lossless, transparency), JPEG (compressed, smaller size), WebP (modern, efficient), PDF (document). For scrolling captures: MP4, GIF, WebM. Default: PNG.

omit_backgroundoptionalBooleandefault: false

Replaces simple white/plain backgrounds with transparency for a cut-out effect. Only works with PNG output. Default: false.

destroy_screenshotoptionalBooleandefault: false

If true, screenshot/PDF is not stored on server and must be downloaded immediately. Default: false.

fail_on_erroroptionalBooleandefault: false

If true, returns an error when the target page responds with 4xx or 5xx status. Default: false.

longitudeoptionalFloat

Specify longitude for the browser Geolocation API. Provide a numeric value. Default: null (not set).

latitudeoptionalFloat

Specify latitude for the browser Geolocation API. Provide a numeric value. Default: null (not set).

proxyoptionalString

Allows defining a proxy for the connection. Provide a JSON string with keys: server (include port number), username, and password.

no_cookie_bannersoptionalBooleandefault: false

Hides or blocks cookie consent banners and popups before capture. Default: false.

block_adsoptionalBooleandefault: false

Blocks requests to known ad networks for cleaner, distraction-free screenshots. Default: false.

headersoptionalString

Custom HTTP headers to include as key=value pairs. Use a semicolon to separate multiple headers (e.g., key1=value1;key2=value2).

cookiesoptionalStringdefault:

Cookies to include in the request before rendering. Supports single or multiple cookies. Example: cookie=value; otherCookie=otherValue;

scroll_to_elementoptionalStringdefault:

Scrolls the page to bring the specified CSS selector into view before capture. Ideal for below-the-fold content. Default: empty.

selectoroptionalStringdefault:

CSS selector to capture a specific element. Only that element is rendered. Falls back to full page if not found. Default: empty.

selector_to_clickoptionalStringdefault:

CSS selector for an element to click before capturing the screenshot. Useful for opening dropdowns, modals, or triggering content.

click_recursionoptionalIntegerdefault: 1

Number of times to click the selector (when set via selector_to_click). Default: 1.

blur_selectoroptionalStringdefault:

CSS selectors to blur before capture. Masks sensitive data like emails, payments, or personal info. Multiple selectors supported. Default: empty.

remove_selectoroptionalStringdefault:

CSS selectors to remove before capture. Deletes matched elements from DOM. Ideal for cleaning ads, popups, sidebars. Multiple selectors supported. Default: empty.

cssoptionalStringdefault:

Allows injecting custom CSS code into the page before rendering. Pass the CSS code directly as a string.

css_urloptionalStringdefault:

Allows loading external CSS into the page. Provide a URL pointing to the CSS file.

jsoptionalStringdefault:

Allows injecting custom JavaScript code into the page before rendering. Pass the JavaScript code directly as a string.

js_urloptionalStringdefault:

Allows loading external JavaScript into the page. Provide a URL pointing to the script file.

ttloptionalIntegerdefault: 2592000

Time in seconds the render stays cached before auto-invalidation. Use higher values for static pages, lower for dynamic content. Default: 2592000 (30 days).

user_agentoptionalStringdefault:

Custom User-Agent string sent in the request headers.

accept_languagesoptionalStringdefault: en-US,en;q=0.8

Sets the accepted languages for the HTTP request. This is sent as the Accept-Language header.

delayoptionalIntegerdefault: 0

Wait period in milliseconds before capture. Allows animations, API responses, and dynamic elements to finish rendering. Default: 0.

thumbnail_widthoptionalInteger

Specifies the width of the thumbnail in pixels. Default value is 0 (meaning no specific value is set, and the screenshot is returned at its original resolution).

outputoptionalStringdefault: json

Set the output format. 'json' returns metadata with a hosted file URL. 'image' streams the raw file bytes directly. Default: json.

freshoptionalBooleandefault: true

If true, bypasses cache and captures a fresh render. If false, returns cached version when available. Default: true.

enable_cachingoptionalBooleandefault: false

Stores the render in cache for reuse on subsequent identical requests. Default: false.

lazy_loadoptionalBooleandefault: false

Automatically scrolls the page to trigger lazy-loaded images and components. Ensures complete content capture. Default: false.

scroll_delayoptionalIntegerdefault: 500

Delay in milliseconds between scroll steps when lazy_load is enabled. Use higher values for heavy pages. Default: 500.

full_pageoptionalBooleandefault: false

Captures the entire webpage from top to bottom, including scrollable content outside the viewport. Ideal for long-form pages. Default: false.

retinaoptionalBooleandefault: false

Captures at 2x resolution for sharper, high-DPI output. Increases file size. Default: false.

heightoptionalIntegerdefault: 867

Viewport height in pixels. Controls how much vertical area is visible. Max: 4320. Default: 867.

widthoptionalIntegerdefault: 1680

Viewport width in pixels. Simulates device screen sizes. Max: 7680. Default: 1680.

custom_htmloptionalStringdefault:

Custom HTML to render instead of loading a URL. Overrides the url option. Use for capturing specific HTML structures or dynamic content.

block_chat_widgetsoptionalBooleandefault: false

Blocks live chat popups, support bubbles, and messaging interfaces. Default: false.

block_jsoptionalBooleandefault: false

Disables all JavaScript execution. Renders a static version of the page. Speeds up capture but may break dynamic content. Default: false.

block_stylesheetsoptionalBooleandefault: false

Blocks all stylesheets - page renders as raw HTML without visual formatting. Default: false.

block_imagesoptionalBooleandefault: false

Blocks all image resources (jpg, png, gif, webp, svg, etc.) for faster rendering. Default: false.

block_mediaoptionalBooleandefault: false

Blocks audio and video resources (mp3, mp4, webm, etc.) from loading. Default: false.

block_fontoptionalBooleandefault: false

Blocks external font files - page falls back to system defaults. Supported: woff, woff2, ttf, otf, eot. Default: false.

block_text_trackoptionalBooleandefault: false

Blocks subtitles and caption overlays from loading. Default: false.

block_xhroptionalBooleandefault: false

Blocks all XMLHttpRequest (AJAX) calls - prevents dynamic API-driven content. Default: false.

block_fetchoptionalBooleandefault: false

Blocks all Fetch API requests - stops async data loading. Default: false.

block_event_sourceoptionalBooleandefault: false

Blocks EventSource (SSE) connections - prevents real-time data streams. Default: false.

block_web_socketoptionalBooleandefault: false

Blocks WebSocket connections - prevents real-time bidirectional communication. Default: false.

block_manifestoptionalBooleandefault: false

Blocks manifest files (.json, .webmanifest) - disables PWA-related functionality. Default: false.

block_specific_requestsoptionalStringdefault:

Fine-grained blocking of specific URLs or patterns. Separate multiple rules by comma, space, or newline. Default: empty.

adjust_topoptionalIntegerdefault: 0

Initial vertical scroll position in pixels before capture. Use to position mid-page content in viewport. Not supported for PDF. Default: 0.

image_qualityoptionalIntegerdefault: 80

Compression level for JPEG output (0-100). Lower = smaller file, higher = better quality. Only applies to JPEG. Default: 80.

extract_htmloptionalBooleandefault: false

Returns rendered HTML as a .html file (includes JS-executed DOM). Only available with output=json. Default: false.

extract_markdownoptionalBooleandefault: false

Extracts rendered page content as a structured .md (Markdown) file. Preserves headings, lists, links. Only with output=json. Default: false.

get_image_urlsoptionalBooleandefault: false

Extracts all image URLs from the rendered DOM and returns them in structured format. Only with output=json. Default: false.

extract_textoptionalBooleandefault: false

Strips all HTML and returns visible text as a .txt file. Ideal for text analysis, indexing, or AI pipelines. Only with output=json. Default: false.

dark_modeoptionalBooleandefault: false

When set to true, websites that support prefers-color-scheme: dark will render in dark mode. Default value is false.

block_trackingoptionalBooleandefault: false

Blocks tracking scripts and analytics services for cleaner, privacy-oriented renders. Default: false.

wait_for_eventoptionalStringdefault: load

Controls when rendering starts based on page load lifecycle. 'load' (all resources), 'domcontentloaded' (HTML parsed), 'networkidle' (no network activity for 500ms). Default: load.

grayscaleoptionalIntegerdefault: 0

Applies a grayscale filter to the screenshot. Requires a value from 0 (no effect) to 100 (fully grayscale). Default value is 0.

clip[x]optionalInteger

X coordinate (in pixels) for the top-left corner of the clip area. Default: null.

clip[y]optionalInteger

Y coordinate (in pixels) for the top-left corner of the clip area. Default: null.

clip[width]optionalInteger

Width of the clip area in pixels. Default: null.

clip[height]optionalInteger

Height of the clip area in pixels. Default: null.

result_file_nameoptionalStringdefault:

Custom name for the output file. Helps with organized storage and retrieval. Note: non-unique names may overwrite existing files.

enable_incognitooptionalBooleandefault: false

Enables private/incognito browsing. Each render starts with a clean slate - no cookies, cache, or session data persisted. Default: false.

timeoutoptionalIntegerdefault: 100000

Maximum wait in milliseconds for page load before aborting. Adjust for slow/heavy pages. Default: 100000 (100s).

Scrolling Screenshot Parameters

Use these additional parameters when capturing scrolling screenshots as a video. Set scrolling_screenshot=true on any URL in the batch to enable scrolling capture mode.

Scrolling captures can be exported in multiple video formats. Use the file_type parameter to choose the output format:webm, mp4, or gif.

Example:scrolling_screenshot=true&file_type=mp4will generate an MP4 video of the page being automatically scrolled from top to bottom.

scrolling_screenshotoptionalBooleandefault: false

Enables scrolling screenshot mode to capture a video (webm, gif, mp4) of the webpage.

file_typeoptionalStringdefault: MP4

Output format for scrolling capture. Options: WEBM (web-optimized), MP4 (widely compatible), GIF (short loops). Default: MP4.

scroll_speedoptionalStringdefault: normal

Scrolling speed: fast, normal, or slow. Affects render time and output pacing. Default: normal.

durationoptionalInteger

Duration of scrolling action in seconds (0-60). Higher = longer video. Default: null (full page scroll).

scroll_backoptionalBooleandefault: false

If true, scrolls to bottom then back to top, creating a seamless loop. Default: false.

start_immediatelyoptionalBooleandefault: false

Starts recording immediately without waiting for full page load. Default: false.

videooptionalBooleandefault: false

Records visible viewport only for a specified duration. Use with duration parameter. Ideal for dashboards and animations. Default: false.

API Response Schema

A successful request returns a 200 OK with a JSON object containing a status string, metadata summary, and a results array with one entry per submitted URL.

status

Stringmandatory

API request status indicator. "success" for successful requests.

total_urls (Integer), successful_urls (Integer), failed_urls (Integer)

status (String), error_message (String | null), url (Object)

Error Status & Codes

See the HTTP Status Codes documentation for a complete reference of common API errors and HTTP status codes.

400

Please provide data in required format in request body

413

Maximum request body size limit exceeded

Quick Links

Quick Links

Bulk Screenshot API Reference

Getting Started

Authentication

API Version

API Request

Query Parameters

Request Body

Request Body Parameters

Scrolling Screenshot Parameters

API Response Schema

Error Status & Codes

Docs

Integrations

Pricing & Accounts

Quick Links

Quick Links

Bulk Screenshot API Reference

Getting Started

Authentication

API Version

API Request

Query Parameters

Request Body

Request Body Parameters

Scrolling Screenshot Parameters

API Response Schema

Error Status & Codes

Docs

Integrations

Pricing & Accounts