API Parameters

Complete reference for all API parameters. Configure every aspect of your captures.

Core Parameters

url
string
required

The website URL to capture. Must be a valid HTTP or HTTPS URL.

format
string
optional

Output format: png, jpg, webp, mp4, webm

Default: png

viewport_width
integer

Browser viewport width in pixels. Range: 100-7680

Default: 1920

viewport_height
integer

Browser viewport height in pixels. Range: 100-4320

Default: 1080

full_page
boolean

Capture the entire page height instead of just the viewport.

Default: false

quality
integer

Image quality/compression level. Range: 1-100. Only applies to JPG and WebP formats.

Default: 90

response_type
string

Response format: image (binary data) or json (metadata with URL)

Default: image

Blocking Parameters

block_ads
boolean

Automatically block advertisements using industry-standard ad block lists.

Default: false

block_cookies
boolean

Automatically block and dismiss cookie consent banners and privacy notices.

Default: false

hide_selectors
string

Comma-separated list of CSS selectors to hide before capturing.

Example: .popup, #chat-widget, .banner

Animation Parameters

scenario
string

Capture type: static (single screenshot), scroll (scrolling animation), or record (video recording)

Default: static

duration
integer

Recording duration in seconds. Range: 1-1800 (tier-dependent maximum)

Default: 5

scroll_delay
integer

Delay between scroll steps in milliseconds.

Default: 500

scroll_by
integer

Number of pixels to scroll per step.

Default: 1000

Advanced Parameters

latitude
float
PRO+

Set geolocation latitude for the capture. Range: -90 to 90

Requires: PRO or ENTERPRISE tier

longitude
float
PRO+

Set geolocation longitude for the capture. Range: -180 to 180

Requires: PRO or ENTERPRISE tier

wait_until
string

When to consider the page ready for capture: load, domcontentloaded, networkidle0, networkidle2

Default: domcontentloaded

delay
integer

Additional delay before capturing in milliseconds. Useful for waiting for animations or dynamic content.

Default: 0

Examples

Live API

Request

curl -X POST https://snagkit.io/api/v1/capture \
  -H "X-API-Key: sk_live_xxx" \
  -d "url=https://example.com" \
  -d "format=png" \
  -d "viewport_width=1920" \
  -d "viewport_height=1080"

Response (200 OK)

{
  "url": "/api/files/.../screenshot_abc.png",
  "size": 245678,
  "format": "PNG",
  "status": "completed",
  "id": "cmg1abc123"
}

Response Headers

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 15
X-Quota-Limit: 100
X-Quota-Remaining: 85