API Documentation

Authorization: Bearer YOUR_API_KEY

curl "https://screenshotapi-api-production.up.railway.app/v1/screenshot\
  ?url=https://github.com\
  &width=1920&height=1080\
  &format=jpeg&quality=90\
  &fullpage=true" \
  -H "Authorization: Bearer sk_live_abc123" \
  -o github.jpeg

{
  "id": "job_1710000000_abc12345",
  "status": "pending",
  "status_url": "/v1/status/job_1710000000_abc12345",
  "message": "Screenshot job queued. Poll the status_url or wait for webhook callback."
}

{
  "id": "job_1710000000_abc12345",
  "status": "completed",
  "created_at": "2026-03-14T10:00:00.000Z",
  "completed_at": "2026-03-14T10:00:03.500Z",
  "duration_ms": 3500,
  "result": {
    "content_type": "image/png",
    "size_bytes": 245760,
    "data_base64": "/9j/4AAQSkZ..."
  }
}

{
  "id": "job_1710000000_abc12345",
  "status": "completed",
  "content_type": "image/png",
  "size_bytes": 245760,
  "duration_ms": 3500,
  "data_base64": "/9j/4AAQSkZ..."
}

const API_KEY = 'YOUR_API_KEY';
const BASE = 'https://screenshotapi-api-production.up.railway.app';

// 1. Start async job
const res = await fetch(`${BASE}/v1/screenshot/async`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    format: 'png',
    width: 1920,
    height: 1080,
  }),
});

const { id, status_url } = await res.json();
console.log('Job started:', id);

// 2. Poll for result
let job;
do {
  await new Promise(r => setTimeout(r, 1000));
  const status = await fetch(`${BASE}${status_url}`);
  job = await status.json();
} while (job.status === 'pending' || job.status === 'processing');

// 3. Save result
if (job.status === 'completed') {
  const buffer = Buffer.from(job.result.data_base64, 'base64');
  require('fs').writeFileSync('screenshot.png', buffer);
  console.log('Done!');
}

curl "https://screenshotapi-api-production.up.railway.app/v1/pdf\
  ?url=https://example.com\
  &format=A4&landscape=true" \
  -H "Authorization: Bearer sk_live_abc123" \
  -o page.pdf

{
  "plan": "pro",
  "used": 1523,
  "limit": 10000,
  "remaining": 8477,
  "reset_date": "2026-04-01"
}

{
  "error": "URL parameter is required"
}

npm install screenshotapi-node

const { ScreenshotAPI } = require('screenshotapi-node');

const client = new ScreenshotAPI('YOUR_API_KEY');

// Capture a screenshot
const buffer = await client.screenshot('https://example.com', {
  width: 1920,
  height: 1080,
  format: 'png',
  fullPage: true,
});
require('fs').writeFileSync('screenshot.png', buffer);

// Generate a PDF
const pdf = await client.pdf('https://example.com', {
  format: 'A4',
  landscape: true,
});
require('fs').writeFileSync('page.pdf', pdf);

// Async screenshot with polling
const result = await client.screenshotAsync('https://example.com', {
  format: 'png',
});
console.log('Job ID:', result.id);

// Check status
const status = await client.getStatus(result.id);
console.log('Status:', status.status);

// Check usage
const usage = await client.getUsage();
console.log(`Used ${usage.used}/${usage.limit} screenshots`);

pip install screenshotapi

from screenshotapi import ScreenshotAPI

client = ScreenshotAPI("YOUR_API_KEY")

# Capture a screenshot
data = client.screenshot("https://example.com", width=1920, height=1080, format="png")
with open("screenshot.png", "wb") as f:
    f.write(data)

# Generate a PDF
pdf_data = client.pdf("https://example.com", format="A4", landscape=True)
with open("page.pdf", "wb") as f:
    f.write(pdf_data)

# Async screenshot
job = client.screenshot_async("https://example.com", format="png")
print(f"Job ID: {job['id']}")

# Check status
status = client.get_status(job["id"])
print(f"Status: {status['status']}")

# Check usage
usage = client.get_usage()
print(f"Used {usage['used']}/{usage['limit']} screenshots")