API Documentation

curl -X POST "https://api.fastscreenshotapi.com/v1/screenshot" \
  -H "X-Api-Key: fsa_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "format": "webp",
    "quality": 90,
    "full_page": true,
    "viewport_width": 1440,
    "block_cookie_banners": true
  }' \
  --output screenshot.webp

const response = await fetch("https://api.fastscreenshotapi.com/v1/screenshot", {
  method: "POST",
  headers: {
    "X-Api-Key": "fsa_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://example.com",
    format: "webp",
    quality: 90,
    full_page: true,
    viewport_width: 1440,
    block_cookie_banners: true,
  }),
});

const buffer = await response.arrayBuffer();
const fs = await import("fs");
fs.writeFileSync("screenshot.webp", Buffer.from(buffer));

console.log("Request ID:", response.headers.get("X-Request-Id"));
console.log("Cached:", response.headers.get("X-Cache"));

import requests

response = requests.post(
    "https://api.fastscreenshotapi.com/v1/screenshot",
    headers={"X-Api-Key": "fsa_your_api_key"},
    json={
        "url": "https://example.com",
        "format": "webp",
        "quality": 90,
        "full_page": True,
        "viewport_width": 1440,
        "block_cookie_banners": True,
    },
)

with open("screenshot.webp", "wb") as f:
    f.write(response.content)

print("Request ID:", response.headers["X-Request-Id"])
print("Cached:", response.headers["X-Cache"])

$ch = curl_init("https://api.fastscreenshotapi.com/v1/screenshot");

curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-Api-Key: fsa_your_api_key",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "url" => "https://example.com",
        "format" => "webp",
        "quality" => 90,
        "full_page" => true,
        "viewport_width" => 1440,
        "block_cookie_banners" => true,
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

file_put_contents("screenshot.webp", $response);

<!-- Direct embedding — uses your API key as a query parameter -->
<img
  src="https://api.fastscreenshotapi.com/v1/screenshot?url=https://example.com&format=webp&viewport_width=1440&api_key=fsa_your_api_key"
  alt="Screenshot of example.com"
  loading="lazy"
/>

const crypto = require('crypto');

app.post('/webhook', (req, res) => {
  const signature = req.headers['x-webhook-signature'];
  const expected = crypto
    .createHmac('sha256', 'your-webhook-secret')
    .update(JSON.stringify(req.body))
    .digest('hex');

  if (signature !== expected) {
    return res.status(401).send('Invalid signature');
  }

  const { job_id, status, screenshot_url } = req.body;
  console.log(`Job ${job_id}: ${status}`);
  res.status(200).send('OK');
});

import hmac, hashlib

@app.route('/webhook', methods=['POST'])
def webhook():
    signature = request.headers.get('X-Webhook-Signature')
    expected = hmac.new(
        b'your-webhook-secret',
        request.data,
        hashlib.sha256
    ).hexdigest()

    if not hmac.compare_digest(signature, expected):
        abort(401)

    data = request.json
    print(f"Job {data['job_id']}: {data['status']}")
    return 'OK', 200

{
    "error": true,
    "code": "SCREENSHOT_TIMEOUT",
    "message": "Page did not finish loading within the timeout.",
    "suggestion": "Try increasing wait_for_timeout or use wait_for: 'domcontentloaded'.",
    "documentation_url": "https://fastscreenshotapi.com/docs#error-codes"
}