API Documentation

Complete guide to integrating SnapAPI into your applications

Getting Started

Authentication
All API requests require authentication using an API key

Include your API key in the X-API-Key header:

X-API-Key: sk_your_api_key_here

Screenshot API

Capture Screenshot
POST /api/screenshot
curl -X POST https://snapapi.co/api/screenshot \
  -H "X-API-Key: sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "viewport": {
      "width": 1920,
      "height": 1080
    },
    "format": "png",
    "quality": 80,
    "fullPage": true
  }'

Request Parameters

ParameterTypeRequiredDescription
urlstringYesThe URL of the website to capture
viewportobjectNoViewport dimensions (default: 1920x1080)
formatstringNoImage format: png, jpeg, webp (default: png)
qualitynumberNoImage quality 1-100 (default: 80)
fullPagebooleanNoCapture full page scroll (default: false)

Rate Limits

Rate limits are enforced based on your subscription tier:

  • Free: 1 request/second, 1,000 requests/month
  • Pro: 10 requests/second, 50,000 requests/month
  • Enterprise: 100 requests/second, 500,000 requests/month

Rate limit headers are included in every response to help you track usage.