Website Screenshot API

Repeatable screenshot evidence: viewport, full-page, or multi-viewport — as PNG or JSON with metadata.

Open docs Pricing

POST /v1/screenshot

Kiln & Clay

Bag · 2

Home/Tableware/Stoneware Bowl — Ash Glaze

ash glaze · Ø18cm

Handmade stoneware

Stoneware Bowl — Ash Glaze

Thrown on the wheel in our Portland studio. Ash glaze pools at the foot.

$68USD · made to order

In stock · ships in 5–7 days

Add to bag

Save

Food-safe · dishwasher top rack
Weight ~480g · foot ring stamped

Care

Hand dry preferred

Origin

Oregon · ash glaze

What you can do with screenshots

ScoutAPI opens a URL in a real browser and delivers visual evidence — as an image, JSON with Base64, or multiple breakpoints in one call. Ideal for QA, visual regression, and alert attachments.

Viewport or full-page shots as PNG/JPEG/PDF
JSON with metadata and optional image content
Multiple viewports (desktop/tablet/mobile) in one request
Pixel diff against a reference PNG for visual regression

API Call

editable

Request bodyJSON

{'{'}

:"jpeg"

{'}'}

Click values to edit. Click mode to switch between viewport and fullpage.

No screenshot yet — choose an endpoint and run

Endpoints & parameters

Pick an endpoint for a sample request and a clear list of parameters.

POST /v1/screenshot

Returns the screenshot directly as binary (image/* or PDF), not as JSON.

Example request

{
  "url": "https://example.com",
  "mode": "viewport",
  "width": 1280,
  "height": 800,
  "wait_ms": 500,
  "format": "jpeg",
  "quality": 82,
  "dismiss_cookie_banner": true
}

Parameters

Name	Type	Description
`url`req	string	Target URL that ScoutAPI opens in the browser.
`mode`	'viewport'\|'fullpage'	Visible viewport or entire page. Default: fullpage.
`width`	number	Viewport width in px (200–3840). Default: 1280.
`height`	number	Viewport height in px (200–2160). Default: 800.
`max_page_height`	number	Upper limit for full-page height.
`wait_ms`	number	Wait time after load before capture (0–30000).
`format`	'jpeg'\|'png'\|'pdf'	Output format. Default: jpeg.
`quality`	number	JPEG quality 1–100.
`dismiss_cookie_banner`	boolean	Attempts to dismiss known cookie banners before measuring or checking.
`wait_for_selector`	string	Waits for a CSS selector before continuing.
`wait_ms / settle_ms`	number	Additional wait time after loading (depends on endpoint).
`device`	string	Playwright device preset; overrides width/height/UA when set.
`color_scheme`	'light'\|'dark'\|'no-preference'	Preferred color scheme in the browser.
`block_ads`	boolean	Blocks known ad and tracker requests.
`capture_xhr`	string	Glob or substring for XHR/fetch URLs whose bodies ScoutAPI captures (max. 20).
`fetch_mode`	'browser'\|'http'	http loads without JavaScript (static document). Default: browser.
`solve_captcha`	boolean	Owned-site Cloudflare JS / Turnstile checkbox. Pair with stealth. Cloud: domain verify. Self-host: always allowed. Not an image-puzzle solver.
`record_har`	boolean	Optionally records HAR (where supported by the endpoint).
`respect_robots`	boolean	Respect robots.txt (default: on).