Parameters

The Scraper API offers comprehensive control through a rich set of parameters. This reference covers all available options organized by category.

Proxy Configuration Permalink to Proxy Configuration

Geo Targeting Permalink to Geo Targeting

proxy_country, proxy_state and proxy_city target the requested location in all modes (request, browser, auto). Only available with residential proxies. Any well-formed value is passed through — unsupported locations fail at the proxy. Supported countries, regions and cities are listed in the Evomi settings API.

Geo targeting does not apply when using proxy_overwrite.

Language Permalink to Language

Overrides the locale presented to the target site. If you don’t set language, the locale follows your proxy automatically — you only need this parameter to force a language that differs from the proxy’s location:

Example — force German (Switzerland) through a US proxy:

{
  "url": "https://example.com",
  "mode": "request",
  "proxy_country": "US",
  "language": "de-CH,de"
}

Notes:

• Tags are plain BCP-47 style codes separated by commas — no q= quality values (de-CH,de ✅, de-CH,de;q=0.9 ❌).
• In request mode, an explicit Accept-Language in additional_headers always wins over language.

Timezone Permalink to Timezone

Sets the browser clock used by Date, Intl and all JavaScript time APIs. If you don’t set timezone, the clock matches your proxy country — the country’s primary IANA zone is used:

Example — Tokyo clock through a US proxy:

{
  "url": "https://example.com",
  "mode": "browser",
  "proxy_country": "US",
  "timezone": "Asia/Tokyo"
}

Notes:

• The value must be a real IANA timezone name; well-formed but nonexistent zones (Europe/Berlint) are rejected with a validation error.
• Multi-zone countries use the primary zone (US → America/New_York, AU → Australia/Sydney). Pass an explicit timezone when you need a specific region.
• Using proxy_overwrite (your own proxy) without timezone or proxy_country? The clock defaults to US Eastern — pass proxy_country or timezone to match your exit IP.

Browser Timing Permalink to Browser Timing

Example:

{
  "mode": "browser",
  "wait_until": "networkidle",
  "wait_seconds": 3
}

Device Emulation Permalink to Device Emulation

AI Enhancement Permalink to AI Enhancement

Custom Headers Permalink to Custom Headers

Example:

{
  "additional_headers": {
    "Authorization": "Bearer token123",
    "Accept-Language": "en-US,en;q=0.9",
    "Custom-Header": "value"
  }
}

Common use cases: API authentication, language preferences, custom tracking headers.

Visual Capture Permalink to Visual Capture

Screenshots are:

• Full-page PNG images (not just viewport)
• Stored in Cloudflare R2 for 30 days
• Accessible via screenshot_uri in response
• Cost: +1 credit

PDF Capture Permalink to PDF Capture

PDFs are:

• Full-page vector documents (searchable and scalable)
• Stored in Cloudflare R2 for 30 days
• Accessible via pdf_uri in response
• Cost: +1 credit

Content Formats Permalink to Content Formats

html - Raw HTML with absolute URLs

markdown - Clean, readable text format (ideal for AI processing)

screenshot - Full-page PNG image (requires mode=browser)

pdf - Full-page PDF document (requires mode=browser)

Parameter Validation Permalink to Parameter Validation

The API validates all parameters before processing. Common validation errors:

• Invalid URL: Must include http:// or https://
• Invalid mode: Must be request, browser, or auto
• Invalid proxy_country: Must be a 2-letter ISO code
• Invalid proxy_session_id: Must be 6-8 alphanumeric characters
• Invalid language: Must be comma-separated language tags (2-3 letters, optional subtags), max 128 characters, no q-values
• Capture without browser: screenshot=true | pdf=true require mode=browser
• AI without source: ai_enhance=true requires ai_source
• Invalid filter: excluded_tags | excluded_selectors require content=markdown | content=html

Validation errors return 422 Unprocessable Entity with details in the response.