API Documentation

Capture any webpage as an image with a single HTTP request.

Authentication

Every request requires an API key. You can pass it as a header or query parameter:

Header (Recommended)

X-API-Key: px_your_api_key_here

Query Parameter

GET /api/capture?url=https://example.com&api_key=px_your_api_key_here

Examples

cURL

curl -H "X-API-Key: px_your_key" \
  "https://pxshot.dev/api/capture?url=https://example.com&width=1280&format=png" \
  --output screenshot.png

JavaScript / Node.js

const response = await fetch(
  'https://pxshot.dev/api/capture?url=https://example.com&format=png',
  { headers: { 'X-API-Key': 'px_your_key' } }
);
const blob = await response.blob();
// Use blob, save to file, etc.

Python

import requests

resp = requests.get(
    'https://pxshot.dev/api/capture',
    params={'url': 'https://example.com', 'format': 'png'},
    headers={'X-API-Key': 'px_your_key'}
)
with open('screenshot.png', 'wb') as f:
    f.write(resp.content)

Full-Page PDF (Pro+)

curl -H "X-API-Key: px_your_key" \
  "https://pxshot.dev/api/capture?url=https://example.com&format=pdf&full_page=true" \
  --output page.pdf

Error Codes

Errors return JSON with an error field:

{ "error": "Missing required parameter: url" }

Rate Limits

Plan Comparison