Screenshot API docs

URL in, image out. One endpoint, binary response, no JSON envelope to unwrap.

Pick your language

What makes a capture correct

Most screenshot failures are not crashes, they are a 200 with the wrong picture. The things we handle, because a benchmark of 202 real pages caught each one:

Options

ParameterDefaultWhat it does
urlrequiredThe page to capture. http/https only; private and reserved addresses are refused.
formatpngpng, jpeg, webp or pdf.
full_pagefalseCapture the whole scrollable page, scrolling first so lazy images load.
viewport_width1280Viewport width in pixels.
viewport_height800Viewport height in pixels.
selectorCapture only the element matching this CSS selector.
block_adsfalseBlock ad networks and collapse the empty slot they leave behind.
block_cookie_bannersfalseRemove consent banners, including ones injected after load.
color_schemelightRender the page as light or dark.
delay0Extra wait before capture, in ms.
cachefalseServe a cached image when one exists. Cache hits are never billed.
fail_on_blankfalseReturn 502 instead of an image when the capture looks blank.

Errors

Failures return JSON with a stable code. Successful captures return the image bytes directly, with no envelope.

{
  "error": {
    "code": "invalid_access_key",
    "message": "Unknown or revoked API key."
  }
}

Common codes: missing_access_key (401), invalid_access_key (403), quota_exceeded (402), render_timeout (504), blank_capture (502).

Failed renders are not billed, and neither are cache hits. We detect a blank capture rather than assuming a 200 means success, so a bot wall that returns an empty page does not come out of your quota.

Signed URLs

The headline use case is putting a capture straight into an <img src>. A raw key in public HTML is a billing incident waiting to happen, so sign the URL instead: the signature covers every parameter, and a tampered URL is refused.

node tools/sign.js "https://example.com" full_page=true

Set REQUIRE_SIGNATURE=true to refuse unsigned requests entirely.

Quota headers

Every response carries your position, so you never need a second request to check:

X-Quota-Limit: 2000
X-Quota-Used: 417
X-Quota-Remaining: 1583
X-Quota-Period: 2026-09