v2

latestOpenAPI 3.1.0Proprietary2026-07-26211984.6 KB
Screenshot

Capture screenshot via query parameters

Returns the screenshot as a binary image. Supports <img src="..."> embedding and browser-based access. All POST parameters are accepted as query params. Accepts API key via Authorization: Bearer, x-api-key header, or ?key= query param.

get/v1/screenshot

Query parameters

urlstring uri required

Webpage URL to capture (must be a valid URL)

format'png' | 'jpeg' | 'webp' | 'pdf'

Output format

widthinteger

Viewport width in pixels

heightinteger

Viewport height in pixels

fullPageboolean

Capture full scrollable page (capped at 16384px height)

qualityinteger

Image quality (JPEG and WebP only)

delayinteger

Wait milliseconds after page load before capture

darkModeboolean

Emulate dark color scheme (prefers-color-scheme: dark)

deviceScaleFactornumber

Device pixel ratio (2 for Retina, 3 for high-DPI)

blockAdsboolean

Block ads, trackers, and chat widgets

timeoutinteger

Navigation timeout in seconds

waitUntil'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'

Page readiness condition before capture

waitForSelectorstring

CSS selector to wait for before capture

bestAttemptboolean

Return partial screenshot on timeout instead of failing

selectorstring

CSS selector of element to capture instead of full page

device'desktop' | 'iphone_15' | 'iphone_se' | 'pixel_8' | 'ipad' | 'ipad_pro'

Device preset that sets viewport, scale, and user agent in one parameter

blockCookieBannersboolean

Hide common cookie and consent walls before capture

resizeWidthinteger

Downscale the output to this width (image formats only). Aspect ratio preserved when only one dimension is set. Never upscales.

resizeHeightinteger

Downscale the output to this height (image formats only).

keystring

API key (alternative to Authorization header)

Response

Screenshot captured successfully

All 21 operations