Skip to main content
GET
Get an on-demand screenshot of a page

Authorizations

X-API-Key
string
header
required

API key passed as the X-API-Key request header. Recommended for server-to-server calls.

Query Parameters

url
string<uri>
required
Example:

"https://shopify.com/pricing"

fullPage
boolean | null

Capture the full scrollable page instead of just the viewport (default false)

Response

Get an on-demand screenshot of a page

url
string
required
finalUrl
string
required

The URL actually captured, after any redirects

imageBase64
string
required

PNG image, base64-encoded

fullPage
boolean
required
capturedAt
string
required