Base endpoint
All scraping runs through GET|POST /api/v1. Complex parameters (extract_rules, js_scenario) should use POST with a JSON body. OpenAPI spec: /api/openapi.
Authentication
Authorization: Bearer sk_live_xxx ?api_key=sk_live_xxx X-API-Key: sk_live_xxx
Create keys after signing in.
Core parameters
- url — target http(s) URL (required)
- render_js — headless Chrome (default true)
- fetch_first — try HTTP before browser
- premium_proxy — residential proxy tier
- wait_for — CSS/XPath selector to wait for
- extract_rules — CSS/XPath field mapping
- ai_query — natural-language extraction
Response headers
Diagnostic Sf-* headers include block type, failure reason, proxy tier, duration, and session ID. See anti-bot guide.
Need the full parameter list?
The complete reference lives in docs/API.md and the interactive OpenAPI spec.