API Reference

The ScreenshotAPI provides a simple, powerful REST endpoint to capture pixel-perfect screenshots of any public or authenticated webpage. We handle headless browser orchestration, waiting, and rendering.

Authentication

Authenticate your API requests by providing your API key in the X-API-Key HTTP header. You can manage your API keys in your dashboard.

Keep your keys secure — do not embed them in client-side applications.

Capture Screenshot

Creates a new screenshot capture. The API is synchronous; the HTTP request will remain open while the screenshot is rendered, and will return the raw binary file directly in the response.

Request Parameters

Response

A successful request returns the literal binary data of the file (e.g., image/png or application/pdf). You should stream this directly to a file on your disk or to your cloud storage.

The response headers will include X-Capture-Id which corresponds to the record stored in your dashboard history.

curl -X POST https://www.screenshotapi.se/v1/capture \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: sk_live_...' \
  -d '{
    "url": "https://example.com",
    "format": "png",
    "full_page": true,
    "width": 1440,
    "height": 1024
  }' \
  --output example.png

import requests

response = requests.post(
    "https://www.screenshotapi.se/v1/capture",
    headers={
        "X-API-Key": "sk_live_...",
        "Content-Type": "application/json",
    },
    json={
        "url": "https://example.com",
        "format": "png",
        "full_page": True,
    }
)

with open("example.png", "wb") as f:
    f.write(response.content)

const fs = require('fs');

fetch('https://www.screenshotapi.se/v1/capture', {
  method: 'POST',
  headers: {
    'X-API-Key': 'sk_live_...',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://example.com',
    format: 'png',
    full_page: true
  })
})
.then(res => res.buffer())
.then(buffer => fs.writeFileSync('example.png', buffer));

/* Binary image data is returned directly */
/* Response headers include: */
Content-Type: image/png
X-Capture-Id: 1042