Screenshot

Capture pixel-perfect screenshots of any website.

Endpoint: GET /v1/brand/screenshot Credits: 5 per request

Parameters

Parameter	Type	Required	Description
`domain`	string	Yes	Domain to screenshot
`url`	string	No	Specific URL to capture (overrides domain homepage)
`format`	string	No	Image format: `png` or `jpeg` (default: `png`)
`width`	number	No	Viewport width in pixels (default: 1440)
`height`	number	No	Viewport height in pixels (default: 900)
`full_page`	boolean	No	Capture full scrollable page (default: false)
`dark_mode`	boolean	No	Enable dark mode preference (default: false)
`quality`	number	No	JPEG quality 1-100 (default: 90)
`delay`	number	No	Wait milliseconds after load before capture (default: 0)

Response Schema

{
  "success": true,
  "data": {
    "url": "https://stripe.com",
    "screenshot_url": "https://cdn.orsa.dev/screenshots/stripe-com-1440x900.png",
    "format": "png",
    "width": 1440,
    "height": 900,
    "file_size_bytes": 524288,
    "captured_at": "2024-12-15T10:30:00Z"
  },
  "credits_used": 5
}

Code Examples

cURL

curl -X GET "https://api.orsa.dev/v1/brand/screenshot?domain=stripe.com&width=1440&format=png" \
  -H "Authorization: Bearer YOUR_API_KEY"

TypeScript

const screenshot = await client.brand.screenshot({
  domain: 'stripe.com',
  format: 'png',
  width: 1440,
  height: 900,
  fullPage: false,
  darkMode: true,
});
 
console.log(screenshot.screenshotUrl); // CDN URL

Python

screenshot = client.brand.screenshot(
    domain="stripe.com",
    format="png",
    width=1440,
    dark_mode=True,
)
 
print(screenshot.screenshot_url)

Notes

Screenshots are stored on a CDN and available for 7 days.
Use dark_mode=true to capture the site with prefers-color-scheme: dark.
For SPAs, use the delay parameter to wait for dynamic content to render.
Maximum resolution is 3840×2160. Full-page captures are limited to 16384px height.

Retrieve Simplified Styleguide