Documentation

Introduction

Snappy API is a powerful API for capturing screenshots, generating PDFs, and extracting structured data from web pages. It's designed for developers who need reliable, fast, and scalable web capture capabilities.

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Quick Start

Get started in minutes with this simple example:

const response = await fetch('https://core.snappyapi.io/v1/screenshot', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://example.com',
    format: 'png',
    viewport: { width: 1200, height: 630 }
  })
});

const result = await response.json();
console.log(result.data.url); // Screenshot URL

URL Screenshots

Capture screenshots of any public webpage with full control over viewport, format, and timing.

{
  "url": "https://example.com",
  "format": "png",           // png, jpeg, webp, pdf
  "viewport": {
    "width": 1200,
    "height": 630
  },
  "fullPage": false,         // Capture full scrolling page
  "waitUntil": "networkidle", // load, domcontentloaded, networkidle
  "delay": 0,                // Wait ms after page load
  "selector": null           // CSS selector to screenshot
}

Response

{
  "success": true,
  "data": {
    "url": "https://cdn.screenshotcore.com/screenshots/abc123.png",
    "width": 1200,
    "height": 630,
    "format": "png",
    "size": 245678,
    "cached": false
  }
}

HTML Rendering

Render custom HTML/CSS directly to images. Perfect for generating invoices, certificates, or social cards.

{
  "html": "<div style='padding: 40px; background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);'><h1 style='color: white; font-size: 48px;'>Hello World</h1></div>",
  "css": "",                 // Optional additional CSS
  "format": "png",
  "viewport": {
    "width": 800,
    "height": 400
  }
}

AI Extraction

Extract structured data from webpages using Claude Vision. Define a schema and let AI parse the content.

{
  "url": "https://example.com/product",
  "prompt": "Extract the product information",
  "schema": {
    "type": "object",
    "properties": {
      "name": { "type": "string" },
      "price": { "type": "number" },
      "description": { "type": "string" },
      "inStock": { "type": "boolean" }
    }
  }
}

Response

{
  "success": true,
  "data": {
    "name": "Wireless Headphones",
    "price": 149.99,
    "description": "Premium noise-canceling headphones...",
    "inStock": true
  },
  "screenshot": "https://cdn.screenshotcore.com/screenshots/abc123.png"
}

Caching

Screenshots are cached by default based on the URL and options. This ensures fast delivery and reduces costs.

Cache Behavior

• Default TTL: 24 hours for standard screenshots
• Cache Key: Based on URL + all options (viewport, format, etc.)
• Bypass: Use cache: false to skip cache

{
  "url": "https://example.com",
  "cache": false  // Always generate a fresh screenshot
}

Options Reference

Error Handling

The API uses standard HTTP status codes and returns detailed error messages.

Rate Limits

Rate limits vary by plan. Check the X-RateLimit-* headers in responses.

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1704067200