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.

GET

https://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 Parameters

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

urlrequiredString

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

file_typeoptionalStringdefault: PNG

Output file type. Options: PNG (lossless), JPG (lossy), WebP (modern), PDF (document).

omit_backgroundoptionalBooleandefault: false

Removes white background and makes it transparent. Only works when file_type is PNG.

destroy_screenshotoptionalBooleandefault: false

If true, screenshot or PDF is not stored and must be downloaded immediately.

fail_on_erroroptionalBooleandefault: false

If true, returns an error for 4xx or 5xx responses from the target page.

longitudeoptionalNumber

Longitude for browser geolocation simulation.

latitudeoptionalNumber

Latitude for browser geolocation simulation.

proxyoptionalStringdefault:

Proxy server configuration. Formats: address:port or username:password@address:port.

no_cookie_bannersoptionalBooleandefault: false

Blocks cookie banners during rendering.

block_adsoptionalBooleandefault: false

Blocks advertisements before rendering.

headersoptionalStringdefault:

Custom HTTP headers to include when the request is sent before rendering.

cookiesoptionalStringdefault:

Cookies to include in the request before rendering.

scroll_to_elementoptionalStringdefault:

CSS selector for an element to scroll to before rendering.

selectoroptionalStringdefault:

CSS selector for the target element to render. Falls back to full page if not found.

blur_selectoroptionalStringdefault:

CSS selectors for elements to blur. Multiple selectors can be added simultaneously.

remove_selectoroptionalStringdefault:

CSS selectors for elements to remove while rendering.

cssoptionalStringdefault:

Inline custom CSS to inject into the page while rendering.

css_urloptionalStringdefault:

URL of external CSS to load into the page while rendering.

jsoptionalStringdefault:

Custom JavaScript code to inject while rendering.

js_urloptionalStringdefault:

URL of external JavaScript to inject while rendering.

ttloptionalNumberdefault: 2592000

Time to live (in seconds) for cache. Controls how long the render stays cached.

user_agentoptionalStringdefault:

Custom User-Agent string sent in the request headers.

accept_languagesoptionalStringdefault: en-US,en;q=0.8

Accept-Language header to set for the request.

delayoptionalNumberdefault: 0

Delay in milliseconds before rendering begins.

thumbnail_widthoptionalNumber

Thumbnail width in pixels. Defaults to original screenshot size if not set.

outputoptionalStringdefault: json

Render output type: 'image' or 'json'.

freshoptionalBooleandefault: true

If true, forces a fresh render. Otherwise uses cached version if available.

enable_cachingoptionalBooleandefault: false

If true, enables caching of the render for future reuse.

lazy_loadoptionalBooleandefault: false

If true, scrolls down the page to trigger loading of lazy-loaded content.

full_pageoptionalBooleandefault: false

If true, captures the entire page (not just the viewport).

retinaoptionalBooleandefault: false

If true, captures with higher pixel density (2x).

heightoptionalNumberdefault: 867

Viewport height in pixels. Max: 4320.

widthoptionalNumberdefault: 1680

Viewport width in pixels. Max: 7680.

custom_htmloptionalStringdefault:

Custom HTML content to render instead of loading a URL.

block_chat_widgetsoptionalBooleandefault: false

Prevents chat widget scripts and resources from loading.

block_jsoptionalBooleandefault: false

Prevents JavaScript files from loading.

block_stylesheetsoptionalBooleandefault: false

Prevents CSS files from loading.

block_imagesoptionalBooleandefault: false

Prevents image files from loading.

block_mediaoptionalBooleandefault: false

Prevents media files (audio and video) from loading.

block_fontsoptionalBooleandefault: false

Prevents font files from loading.

block_text_trackoptionalBooleandefault: false

Prevents text track files (subtitles, captions) from loading.

block_xhroptionalBooleandefault: false

Blocks XMLHttpRequest (XHR) requests.

block_fetchoptionalBooleandefault: false

Blocks Fetch API requests.

block_event_sourceoptionalBooleandefault: false

Prevents Server-Sent Events (EventSource) connections.

block_web_socketoptionalBooleandefault: false

Prevents WebSocket connections.

block_manifestoptionalBooleandefault: false

Prevents manifest files (.json, .webmanifest) from loading.

block_specific_requestsoptionalStringdefault:

Prevents specific requests by URL patterns, separated by comma, space, or newline.

adjust_topoptionalNumberdefault: 0

Scroll to a vertical pixel position from top before rendering. Not supported for PDF.

image_qualityoptionalNumberdefault: 80

Quality of rendered image for JPG/JPEG output (0–100).

extract_htmloptionalBooleandefault: false

Retrieves raw HTML content as a .html file. Only available when output is JSON.

extract_textoptionalBooleandefault: false

Retrieves plain text content as a .txt file. Only available when output is JSON.

dark_modeoptionalBooleandefault: false

Enables dark mode for websites that support it.

block_trackingoptionalBooleandefault: false

Prevents loading of tracking scripts and analytics services.

wait_for_eventoptionalStringdefault: load

Specifies when to start rendering. Options: 'load', 'domcontentloaded', 'networkidle'.

grayscaleoptionalNumberdefault: 0

Applies grayscale effect from 0 (no effect) to 100 (fully grayscale).

clipoptionalObject

Captures a specific rectangular area. Includes x, y, width, and height properties.

result_file_nameoptionalStringdefault:

Custom name for the output file.

incognito_modeoptionalBooleandefault: false

Enables private browsing mode that doesn't store any browsing data.

timeoutoptionalNumberdefault: 100000

Timeout duration in milliseconds for navigation.

Scrolling Screenshot Parameters

Use these additional parameters when capturing scrolling screenshots (video format). Set scrolling_screenshot=true to enable this mode.

scrolling_screenshotrequiredBooleandefault: false

Enables scrolling screenshot mode to capture a video of the webpage.

multiple_scrollingoptionalBooleandefault: false

Captures multiple scrolling screenshots with different dimensions. Requires the sizes parameter.

sizesoptionalArray

JSON array of objects with width and height for multiple scrolling captures. Required with multiple_scrolling.

file_typeoptionalStringdefault: MP4

Output format for scrolling capture. Options: WEBM, MP4, GIF.

scroll_speedoptionalStringdefault: normal

Speed of scrolling during rendering. Options: fast, normal, slow.

durationoptionalNumber

Duration of the scrolling action in seconds (0–60).

scroll_backoptionalBooleandefault: false

When enabled, page scrolls to bottom then returns to top, creating a loop.

start_immediatelyoptionalBooleandefault: false

Starts recording immediately without waiting for the page to fully load.

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

URL of the captured screenshot or video file.

url

Stringmandatory

The original URL that was processed.

created_at

Stringmandatory

ISO 8601 timestamp when the screenshot was created.

format

Stringmandatory

Output format type ('json' or 'image').

ttl

Stringmandatory

ISO 8601 expiry timestamp for the screenshot.

sizes

Array|nulloptional

Dimensions used for multiple scrolling captures. Null if not used.

extracted_html

Stringoptional

URL of extracted HTML file. Present when extract_html=true.

[param_name]

Mixedoptional

Any request parameter passed with non-default value is echoed back in the response.

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

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

GET

https://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 Parameters

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

urlrequiredString

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

file_typeoptionalStringdefault: PNG

Output file type. Options: PNG (lossless), JPG (lossy), WebP (modern), PDF (document).

omit_backgroundoptionalBooleandefault: false

Removes white background and makes it transparent. Only works when file_type is PNG.

destroy_screenshotoptionalBooleandefault: false

If true, screenshot or PDF is not stored and must be downloaded immediately.

fail_on_erroroptionalBooleandefault: false

If true, returns an error for 4xx or 5xx responses from the target page.

longitudeoptionalNumber

Longitude for browser geolocation simulation.

latitudeoptionalNumber

Latitude for browser geolocation simulation.

proxyoptionalStringdefault:

Proxy server configuration. Formats: address:port or username:password@address:port.

no_cookie_bannersoptionalBooleandefault: false

Blocks cookie banners during rendering.

block_adsoptionalBooleandefault: false

Blocks advertisements before rendering.

headersoptionalStringdefault:

Custom HTTP headers to include when the request is sent before rendering.

cookiesoptionalStringdefault:

Cookies to include in the request before rendering.

scroll_to_elementoptionalStringdefault:

CSS selector for an element to scroll to before rendering.

selectoroptionalStringdefault:

CSS selector for the target element to render. Falls back to full page if not found.

blur_selectoroptionalStringdefault:

CSS selectors for elements to blur. Multiple selectors can be added simultaneously.

remove_selectoroptionalStringdefault:

CSS selectors for elements to remove while rendering.

cssoptionalStringdefault:

Inline custom CSS to inject into the page while rendering.

css_urloptionalStringdefault:

URL of external CSS to load into the page while rendering.

jsoptionalStringdefault:

Custom JavaScript code to inject while rendering.

js_urloptionalStringdefault:

URL of external JavaScript to inject while rendering.

ttloptionalNumberdefault: 2592000

Time to live (in seconds) for cache. Controls how long the render stays cached.

user_agentoptionalStringdefault:

Custom User-Agent string sent in the request headers.

accept_languagesoptionalStringdefault: en-US,en;q=0.8

Accept-Language header to set for the request.

delayoptionalNumberdefault: 0

Delay in milliseconds before rendering begins.

thumbnail_widthoptionalNumber

Thumbnail width in pixels. Defaults to original screenshot size if not set.

outputoptionalStringdefault: json

Render output type: 'image' or 'json'.

freshoptionalBooleandefault: true

If true, forces a fresh render. Otherwise uses cached version if available.

enable_cachingoptionalBooleandefault: false

If true, enables caching of the render for future reuse.

lazy_loadoptionalBooleandefault: false

If true, scrolls down the page to trigger loading of lazy-loaded content.

full_pageoptionalBooleandefault: false

If true, captures the entire page (not just the viewport).

retinaoptionalBooleandefault: false

If true, captures with higher pixel density (2x).

heightoptionalNumberdefault: 867

Viewport height in pixels. Max: 4320.

widthoptionalNumberdefault: 1680

Viewport width in pixels. Max: 7680.

custom_htmloptionalStringdefault:

Custom HTML content to render instead of loading a URL.

block_chat_widgetsoptionalBooleandefault: false

Prevents chat widget scripts and resources from loading.

block_jsoptionalBooleandefault: false

Prevents JavaScript files from loading.

block_stylesheetsoptionalBooleandefault: false

Prevents CSS files from loading.

block_imagesoptionalBooleandefault: false

Prevents image files from loading.

block_mediaoptionalBooleandefault: false

Prevents media files (audio and video) from loading.

block_fontsoptionalBooleandefault: false

Prevents font files from loading.

block_text_trackoptionalBooleandefault: false

Prevents text track files (subtitles, captions) from loading.

block_xhroptionalBooleandefault: false

Blocks XMLHttpRequest (XHR) requests.

block_fetchoptionalBooleandefault: false

Blocks Fetch API requests.

block_event_sourceoptionalBooleandefault: false

Prevents Server-Sent Events (EventSource) connections.

block_web_socketoptionalBooleandefault: false

Prevents WebSocket connections.

block_manifestoptionalBooleandefault: false

Prevents manifest files (.json, .webmanifest) from loading.

block_specific_requestsoptionalStringdefault:

Prevents specific requests by URL patterns, separated by comma, space, or newline.

adjust_topoptionalNumberdefault: 0

Scroll to a vertical pixel position from top before rendering. Not supported for PDF.

image_qualityoptionalNumberdefault: 80

Quality of rendered image for JPG/JPEG output (0–100).

extract_htmloptionalBooleandefault: false

Retrieves raw HTML content as a .html file. Only available when output is JSON.

extract_textoptionalBooleandefault: false

Retrieves plain text content as a .txt file. Only available when output is JSON.

dark_modeoptionalBooleandefault: false

Enables dark mode for websites that support it.

block_trackingoptionalBooleandefault: false

Prevents loading of tracking scripts and analytics services.

wait_for_eventoptionalStringdefault: load

Specifies when to start rendering. Options: 'load', 'domcontentloaded', 'networkidle'.

grayscaleoptionalNumberdefault: 0

Applies grayscale effect from 0 (no effect) to 100 (fully grayscale).

clipoptionalObject

Captures a specific rectangular area. Includes x, y, width, and height properties.

result_file_nameoptionalStringdefault:

Custom name for the output file.

incognito_modeoptionalBooleandefault: false

Enables private browsing mode that doesn't store any browsing data.

timeoutoptionalNumberdefault: 100000

Timeout duration in milliseconds for navigation.

Scrolling Screenshot Parameters

Use these additional parameters when capturing scrolling screenshots (video format). Set scrolling_screenshot=true to enable this mode.

scrolling_screenshotrequiredBooleandefault: false

Enables scrolling screenshot mode to capture a video of the webpage.

multiple_scrollingoptionalBooleandefault: false

Captures multiple scrolling screenshots with different dimensions. Requires the sizes parameter.

sizesoptionalArray

JSON array of objects with width and height for multiple scrolling captures. Required with multiple_scrolling.

file_typeoptionalStringdefault: MP4

Output format for scrolling capture. Options: WEBM, MP4, GIF.

scroll_speedoptionalStringdefault: normal

Speed of scrolling during rendering. Options: fast, normal, slow.

durationoptionalNumber

Duration of the scrolling action in seconds (0–60).

scroll_backoptionalBooleandefault: false

When enabled, page scrolls to bottom then returns to top, creating a loop.

start_immediatelyoptionalBooleandefault: false

Starts recording immediately without waiting for the page to fully load.

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

URL of the captured screenshot or video file.

url

Stringmandatory

The original URL that was processed.

created_at

Stringmandatory

ISO 8601 timestamp when the screenshot was created.

format

Stringmandatory

Output format type ('json' or 'image').

ttl

Stringmandatory

ISO 8601 expiry timestamp for the screenshot.

sizes

Array|nulloptional

Dimensions used for multiple scrolling captures. Null if not used.

extracted_html

Stringoptional

URL of extracted HTML file. Present when extract_html=true.

[param_name]

Mixedoptional

Any request parameter passed with non-default value is echoed back in the response.

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

400

Your URL is incorrect

400

please pass correct parameters

408

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