SearchCtrl+K

Website Screenshot API Reference

Capture websites exactly as users experience them - full-page, scrolling, and dynamic. Generate pixel-perfect screenshots or videos (MP4, GIF, WebM) from any public or protected URL with complete browser control.

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

Test

Pass the target URL and optional rendering parameters as query strings. The API launches a headless browser, renders the page, and returns a JSON response containing the screenshot URL and metadata. Use the output=image parameter to receive the raw image bytes directly instead.

Getting Started

Authentication

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

API Version

This is version v1.0 of the API.

LANGUAGE

curl -X 'GET' \
  'https://api.apifreaks.com/v1.0/screenshot?url=https%3A%2F%2Fgithub.com' \
  -H 'X-apiKey: API-KEY'

Response

{
  "screenshot": "https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/github_com_2dee90f0bba5.png",
  "url": "https://github.com",
  "created_at": "2026-06-05T15: 49: 55.921Z",
  "format": "json",
  "ttl": "2026-07-05T15: 49: 52.012Z",
  "sizes": null
}

API Request

Pass parameters as query strings appended to the endpoint URL. Only url and apiKey are required - all other parameters are optional with sensible defaults.

Query Parameters

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.

multiple_scrollingoptionalBooleandefault: false

Captures multiple scrolling screenshots at different viewport sizes in one request. Requires the sizes parameter.

sizesoptionalArray

JSON array of {id, width, height} objects for multiple scrolling captures. Required when multiple_scrolling is true.

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 response with a JSON object. The core fields are always present; any request parameter passed with a non-default value is echoed back in the response.

screenshot

Stringmandatory

Specifies the file type for the output.

url

Stringmandatory

The original URL that was captured.

created_at

Stringmandatory

Timestamp when the screenshot was created (ISO 8601 format).

format

Stringmandatory

Response format type.

ttl

Stringmandatory

Time until the screenshot expires (ISO 8601 format).

file_type

Stringoptional

The file type of the output.

extracted_html

Stringoptional

URL of the extracted HTML from the webpage

extracted_text

Stringoptional

URL of the extracted plain text from the webpage

enable_caching

Booleanoptional

Whether caching was enabled (true/false).

omit_background

Booleanoptional

Whether background was removed (true/false).

destroy_screenshot

Booleanoptional

Whether the screenshot was destroyed after generation (true/false).

fail_on_error

Booleanoptional

Whether the request failed on error (true/false).

longitude

Integeroptional

The longitude value used for geolocation.

latitude

Integeroptional

The latitude value used for geolocation.

proxy

Stringoptional

The proxy configuration used for the request.

no_cookie_banners

Booleanoptional

Whether cookie banners were blocked (true/false).

block_ads

Booleanoptional

Whether ads were blocked (true/false).

headers

Stringoptional

The custom headers that were included in the request.

cookies

Stringoptional

The cookies that were included in the request.

scroll_to_element

Stringoptional

The element that was scrolled to before rendering.

selector

Stringoptional

The element that was selected for rendering.

blur_selector

Stringoptional

The elements that were blurred in the output.

remove_selector

Stringoptional

The elements that were removed from the output.

css

Stringoptional

The custom CSS that was injected into the page.

css_url

Stringoptional

The external CSS URL that was loaded.

js

Stringoptional

The custom JavaScript that was injected.

js_url

Stringoptional

The external JavaScript URL that was loaded.

user_agent

Stringoptional

The User-Agent string that was used.

accept_languages

Stringoptional

The Accept-Language header that was used.

delay

Integeroptional

The delay duration that was applied in milliseconds.

thumbnail_width

Integeroptional

The thumbnail width that was used in pixels.

output

Stringoptional

The output type that was used.

fresh

Booleanoptional

Whether a fresh render was performed (true/false).

enable_caching

Booleanoptional

Whether caching was enabled (true/false).

lazy_load

Booleanoptional

Whether lazy loading was triggered (true/false).

full_page

Booleanoptional

Whether full page capture was used (true/false).

retina

Booleanoptional

Whether retina capture was used (true/false).

height

Integeroptional

The viewport height that was used in pixels.

width

Integeroptional

The viewport width that was used in pixels.

custom_html

Stringoptional

The custom HTML content that was rendered.

block_chat_widgets

Booleanoptional

Whether chat widgets were blocked (true/false).

block_js

Booleanoptional

Whether JavaScript was blocked (true/false).

block_stylesheets

Booleanoptional

Whether stylesheets were blocked (true/false).

block_images

Booleanoptional

Whether images were blocked (true/false).

block_media

Booleanoptional

Whether media files were blocked (true/false).

block_font

Booleanoptional

Whether fonts were blocked (true/false).

block_text_track

Booleanoptional

Whether text tracks were blocked (true/false).

block_xhr

Booleanoptional

Whether XHR requests were blocked (true/false).

block_fetch

Booleanoptional

Whether Fetch API requests were blocked (true/false).

block_event_source

Booleanoptional

Whether EventSource connections were blocked (true/false).

block_web_socket

Booleanoptional

Whether WebSocket connections were blocked (true/false).

block_manifest

Booleanoptional

Whether manifest files were blocked (true/false).

block_specific_requests

Stringoptional

The specific requests that were blocked.

adjust_top

Integeroptional

The vertical position that was scrolled to in pixels.

image_quality

Integeroptional

The image quality level that was applied.

extract_html

Booleanoptional

Whether HTML content was extracted (true/false).

extract_text

Booleanoptional

Whether text content was extracted (true/false).

dark_mode

Booleanoptional

Whether dark mode was enabled (true/false).

block_tracking

Booleanoptional

Whether tracking scripts were blocked (true/false).

wait_for_event

Stringoptional

The event that triggered the rendering to start.

grayscale

Integeroptional

The grayscale level that was applied (0-100).

clip

Objectoptional

The dimensions of the clipped area that was captured.

result_file_name

Stringoptional

The final filename used for the output file.

enable_incognito

Booleanoptional

Whether incognito mode was enabled (true/false).

timeout

Integeroptional

The actual timeout duration that was applied in milliseconds.

scrolling_screenshot

Booleanoptional

Whether scrolling screenshot mode was enabled (true/false).

multiple_scrolling

Booleanoptional

Whether multiple scrolling captures were performed (true/false).

sizes

Arraymandatory

The dimensions used for each capture in the array.

extract_markdown

Booleanoptional

Whether markdown extraction was enabled (true/false).

get_image_urls

Booleanoptional

Whether image URL extraction was enabled (true/false).

scroll_delay

Integeroptional

The delay between scroll steps that was applied in milliseconds.

selector_to_click

Stringoptional

The CSS selector of the element that was clicked before capture.

click_recursion

Integeroptional

The number of times the selector was clicked.

video

Booleanoptional

Whether viewport recording mode was enabled (true/false).

Error Status & Codes

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

400

Your URL is incorrect

400

please pass correct parameters

408

The request took too long to complete. Please try again later.

Website Screenshot API Reference

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

Test

Getting Started

Authentication

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

API Version

This is version v1.0 of the API.

LANGUAGE

curl -X 'GET' \
  'https://api.apifreaks.com/v1.0/screenshot?url=https%3A%2F%2Fgithub.com' \
  -H 'X-apiKey: API-KEY'

Response

{
  "screenshot": "https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/github_com_2dee90f0bba5.png",
  "url": "https://github.com",
  "created_at": "2026-06-05T15: 49: 55.921Z",
  "format": "json",
  "ttl": "2026-07-05T15: 49: 52.012Z",
  "sizes": null
}

API Request

Pass parameters as query strings appended to the endpoint URL. Only url and apiKey are required - all other parameters are optional with sensible defaults.

Query Parameters

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.

multiple_scrollingoptionalBooleandefault: false

Captures multiple scrolling screenshots at different viewport sizes in one request. Requires the sizes parameter.

sizesoptionalArray

JSON array of {id, width, height} objects for multiple scrolling captures. Required when multiple_scrolling is true.

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 response with a JSON object. The core fields are always present; any request parameter passed with a non-default value is echoed back in the response.

screenshot

Stringmandatory

Specifies the file type for the output.

url

Stringmandatory

The original URL that was captured.

created_at

Stringmandatory

Timestamp when the screenshot was created (ISO 8601 format).

format

Stringmandatory

Response format type.

ttl

Stringmandatory

Time until the screenshot expires (ISO 8601 format).

file_type

Stringoptional

The file type of the output.

extracted_html

Stringoptional

URL of the extracted HTML from the webpage

extracted_text

Stringoptional

URL of the extracted plain text from the webpage

enable_caching

Booleanoptional

Whether caching was enabled (true/false).

omit_background

Booleanoptional

Whether background was removed (true/false).

destroy_screenshot

Booleanoptional

Whether the screenshot was destroyed after generation (true/false).

fail_on_error

Booleanoptional

Whether the request failed on error (true/false).

longitude

Integeroptional

The longitude value used for geolocation.

latitude

Integeroptional

The latitude value used for geolocation.

proxy

Stringoptional

The proxy configuration used for the request.

no_cookie_banners

Booleanoptional

Whether cookie banners were blocked (true/false).

block_ads

Booleanoptional

Whether ads were blocked (true/false).

headers

Stringoptional

The custom headers that were included in the request.

cookies

Stringoptional

The cookies that were included in the request.

scroll_to_element

Stringoptional

The element that was scrolled to before rendering.

selector

Stringoptional

The element that was selected for rendering.

blur_selector

Stringoptional

The elements that were blurred in the output.

remove_selector

Stringoptional

The elements that were removed from the output.

css

Stringoptional

The custom CSS that was injected into the page.

css_url

Stringoptional

The external CSS URL that was loaded.

js

Stringoptional

The custom JavaScript that was injected.

js_url

Stringoptional

The external JavaScript URL that was loaded.

user_agent

Stringoptional

The User-Agent string that was used.

accept_languages

Stringoptional

The Accept-Language header that was used.

delay

Integeroptional

The delay duration that was applied in milliseconds.

thumbnail_width

Integeroptional

The thumbnail width that was used in pixels.

output

Stringoptional

The output type that was used.

fresh

Booleanoptional

Whether a fresh render was performed (true/false).

enable_caching

Booleanoptional

Whether caching was enabled (true/false).

lazy_load

Booleanoptional

Whether lazy loading was triggered (true/false).

full_page

Booleanoptional

Whether full page capture was used (true/false).

retina

Booleanoptional

Whether retina capture was used (true/false).

height

Integeroptional

The viewport height that was used in pixels.

width

Integeroptional

The viewport width that was used in pixels.

custom_html

Stringoptional

The custom HTML content that was rendered.

block_chat_widgets

Booleanoptional

Whether chat widgets were blocked (true/false).

block_js

Booleanoptional

Whether JavaScript was blocked (true/false).

block_stylesheets

Booleanoptional

Whether stylesheets were blocked (true/false).

block_images

Booleanoptional

Whether images were blocked (true/false).

block_media

Booleanoptional

Whether media files were blocked (true/false).

block_font

Booleanoptional

Whether fonts were blocked (true/false).

block_text_track

Booleanoptional

Whether text tracks were blocked (true/false).

block_xhr

Booleanoptional

Whether XHR requests were blocked (true/false).

block_fetch

Booleanoptional

Whether Fetch API requests were blocked (true/false).

block_event_source

Booleanoptional

Whether EventSource connections were blocked (true/false).

block_web_socket

Booleanoptional

Whether WebSocket connections were blocked (true/false).

block_manifest

Booleanoptional

Whether manifest files were blocked (true/false).

block_specific_requests

Stringoptional

The specific requests that were blocked.

adjust_top

Integeroptional

The vertical position that was scrolled to in pixels.

image_quality

Integeroptional

The image quality level that was applied.

extract_html

Booleanoptional

Whether HTML content was extracted (true/false).

extract_text

Booleanoptional

Whether text content was extracted (true/false).

dark_mode

Booleanoptional

Whether dark mode was enabled (true/false).

block_tracking

Booleanoptional

Whether tracking scripts were blocked (true/false).

wait_for_event

Stringoptional

The event that triggered the rendering to start.

grayscale

Integeroptional

The grayscale level that was applied (0-100).

clip

Objectoptional

The dimensions of the clipped area that was captured.

result_file_name

Stringoptional

The final filename used for the output file.

enable_incognito

Booleanoptional

Whether incognito mode was enabled (true/false).

timeout

Integeroptional

The actual timeout duration that was applied in milliseconds.

scrolling_screenshot

Booleanoptional

Whether scrolling screenshot mode was enabled (true/false).

multiple_scrolling

Booleanoptional

Whether multiple scrolling captures were performed (true/false).

sizes

Arraymandatory

The dimensions used for each capture in the array.

extract_markdown

Booleanoptional

Whether markdown extraction was enabled (true/false).

get_image_urls

Booleanoptional

Whether image URL extraction was enabled (true/false).

scroll_delay

Integeroptional

The delay between scroll steps that was applied in milliseconds.

selector_to_click

Stringoptional

The CSS selector of the element that was clicked before capture.

click_recursion

Integeroptional

The number of times the selector was clicked.

video

Booleanoptional

Whether viewport recording mode was enabled (true/false).

Error Status & Codes

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

400

Your URL is incorrect

400

please pass correct parameters

408

The request took too long to complete. Please try again later.

Quick Links

Quick Links

Website Screenshot API Reference

Getting Started

Authentication

API Version

API Request

Query Parameters

Scrolling Screenshot Parameters

API Response Schema

Error Status & Codes

Docs

Integrations

Pricing & Accounts

Quick Links

Quick Links

Website Screenshot API Reference

Getting Started

Authentication

API Version

API Request

Query Parameters

Scrolling Screenshot Parameters

API Response Schema

Error Status & Codes

Docs

Integrations

Pricing & Accounts