API Reference
Complete parameter reference, error codes, and support
Parameter Reference
Complete list of all request parameters.
| Parameter | Type | Default | Description |
|---|---|---|---|
url | string | required | Target URL to scrape. Must be HTTP or HTTPS. |
api_key | string | required | Your API key for authentication. |
scrape_tier | string | standard | Proxy tier: standard, advanced, or hyperdrive. |
country_code | string | — | ISO 3166-1 alpha-2 country code. Requires advanced/hyperdrive tier. |
custom_proxy | string | — | Your own proxy. Format: http(s):user:pass@host:port. Overrides tier. |
session_number | integer | — | Sticky session ID. Same number = same proxy IP. |
render_js | boolean | true | Use headless browser with JS execution. Set false for fast HTTP-only. |
device_type | string | desktop | Device emulation: desktop (1920x1080) or mobile (390x844). |
wait_browser | string | — | Navigation event to wait for: domcontentloaded, load, or networkidle. Requires render_js. |
wait_for | string | — | CSS selector to wait for. 15s timeout. Requires render_js. |
wait_ms | integer | — | Fixed delay in ms after wait_for. Range: 0–30,000. Requires render_js. |
block_resources | boolean | true | Block images, CSS, fonts, tracking scripts. Auto-disabled for screenshots. Requires render_js. |
block_ads | boolean | false | Block advertisement scripts and content. |
forward_sdrive_headers | boolean | false | Forward sdrive--prefixed headers to target (prefix stripped). |
timeout_ms | integer | 95000 (sync) / 130000 (async) | Max request time in ms. Range: 10,000–130,000. |
result_type | string | html | Output format: html, page_text, or page_markdown. |
screenshot | boolean | false | Capture viewport as PNG. Returns screenshot_url (24h). |
screenshot_fullpage | boolean | false | Capture full scrollable page as PNG. |
screenshot_selector | string | — | Capture specific element by CSS selector as PNG. |
Errors
Status Codes
| Code | Meaning |
|---|---|
| 200 | Success (sync) |
| 202 | Job accepted (async) |
| 402 | Payment required — insufficient credits or no active plan |
| 422 | Validation error — check your parameters |
| 429 | Rate limited — slow down |
| 504 | Timeout — the page took too long to load |
Error Response
Error responses return JSON:
{
"error": {
"code": "VALIDATION_ERROR",
"message": "url is required"
}
}Support
- Email: support@scrapedrive.com
- Website: scrapedrive.com