# Parameters

Source: https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/

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

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `url` | string | Yes | - | Target URL to scrape (must include `http://` or `https://`) |
| `mode` | string | No | `auto` | [Modes](/scraping-products-instructions/scraper-api/parameters/scraping-modes/): `request`, `browser`, or `auto`  |
| `delivery` | string | No | `raw` | [Delivery](/scraping-products-instructions/scraper-api/parameters/output-formats/): `raw` (direct content) or `json` (wrapped) |
| `async` | boolean | No | `false` | Submit task for background processing 
| `content` | string | No | `html` | [Delivery](/scraping-products-instructions/scraper-api/parameters/output-formats/): `html`, `markdown`, `pdf` or `screenshot` |
| `include_content` | boolean | No | `false` | [Delivery](/scraping-products-instructions/scraper-api/parameters/output-formats/): Include full content in JSON responses |
| `excluded_tags` | array/string | No | [] | [Filtering](/scraping-products-instructions/scraper-api/parameters/filtering/): HTML tag names to remove (e.g., ["script", "form"]) |
| `excluded_selectors` | array/string | No | [] |  [Filtering](/scraping-products-instructions/scraper-api/parameters/filtering/): CSS selectors to remove (e.g., [".tracker", "#ads"]) |
| `extract_scheme` | object | No | - | [Extraction](/scraping-products-instructions/scraper-api/parameters/extraction/schema/) scheme using CSS, XPath, and Regex.  |
| `scheme_id` | str | No | - | [Extraction](/scraping-products-instructions/scraper-api/parameters/extraction/schema/) scheme ID using CSS, XPath, and Regex. From /schemes/. |
| `js_instructions` | array | No  | - | [JavaScript](/scraping-products-instructions/scraper-api/parameters/javascript-automation/) Structured actions to perform (click, fill, wait) |
| `execute_js` | string | No | -  | Raw [JavaScript](/scraping-products-instructions/scraper-api/parameters/javascript-automation/) code to execute |
| `networkCapture` | array | No  | - | [Network](/scraping-products-instructions/scraper-api/parameters/network-capture/) Filters to capture browser network responses (max 10 filters) |
| `capture_headers` | bool | No  | - | Captures the HTTP response and cookie headers |
| `block_resources` | array/string | No | []  | Resource to block, options: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest` |
| `use_default_storage` | boolean | No | false | Use your default [Cloud Storage](/scraping-products-instructions/scraper-api/cloud-storage/) configuration to use for uploading results. |
| `storage_id` | string | No | - | Specific [Cloud Storage](/scraping-products-instructions/scraper-api/cloud-storage/) configuration ID to use for uploading results. |
| `webhook` | object | No | - | [Webhooks](/scraping-products-instructions/scraper-api/webhooks/) configuration for real-time notifications |

## Proxy Configuration 

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `proxy_type` | string | `residential` | Proxy type: `residential` or `datacenter` |
| `proxy_country` | string | `US` | Two-letter ISO country code (e.g., `GB`, `DE`, `JP`) |
| `proxy_session_id` | string | - | Session ID (6-8 characters) for IP persistence |
| `proxy_overwrite` | string | - | Full proxy URL to override default proxies |

## Browser Timing

| Parameter | Type | Default | Range | Description |
|-----------|------|---------|-------|-------------|
| `wait_seconds` | integer | `0` | 0-30 | Seconds to wait after page load |
| `wait_until` | string | `domcontentloaded` | - | Page ready state options |
| `domcontentloaded` | - | - | - | DOM is ready (recommended) - Most dynamic sites |
| `load` | - | - | - | All resources loaded - Complete page with images |
| `networkidle` | - | - | - | No network activity - Heavy AJAX/API calls |
| `commit` | - | - | - | Navigation committed (fastest) - Simple static pages |

**Example:**
```json
{
  "mode": "browser",
  "wait_until": "networkidle",
  "wait_seconds": 3
}
```
## Device Emulation

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `device` | string | `windows` | Device to emulate options |
| `windows` | - | - | Viewport: 1920×1080, User-Agent: Chrome/Windows, Scrolling: Enabled (5000px), Best For: Desktop sites, dashboards |
| `macos` | - | - | Viewport: 1920×1080, User-Agent: Safari/macOS, Scrolling: Enabled (5000px), Best For: macOS-specific content |
| `android` | - | - | Viewport: 375×667, User-Agent: Chrome/Android, Scrolling: Disabled, Best For: Mobile-first sites, apps |

## AI Enhancement

| Parameter | Type | Default | Required When | Description |
|-----------|------|---------|---------------|-------------|
| `ai_enhance` | boolean | `false` | - | Enable AI processing |
| `ai_source` | string | - | ai_enhance=true | Source: `markdown` or `screenshot` |
| `ai_prompt` | string | - | No | Custom prompt for AI processing |
| `ai_force_json` | boolean | `true` | No | Force JSON output format |

## Custom Headers

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `additional_headers` | object | - | Custom HTTP headers to send with the request |

**Example:**
```json
{
  "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

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `screenshot` | boolean | `false` | Capture full-page screenshot (requires `mode=browser`) |

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

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `pdf` | boolean | `false` | Capture full-page PDF document (requires `mode=browser`) |

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

**`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

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
- **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.

## Pages in this section

- [Output Formats](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/output-formats/index.md): Choose HTML, markdown, a screenshot or a PDF with content=, and raw or JSON delivery.
- [Filtering](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/filtering/index.md): excludedtags and excludedselectors strip elements before the response is built, which also changes what extraction and the AI step see.
- [Fix](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/extraction/schema/fix/index.md): With test and fix both true, the API writes or repairs an extractscheme from your prompt against the live page, and saves it only if it works.
- [Scraping Modes](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/scraping-modes/index.md): mode=request is a fast HTTP fetch, mode=browser renders JavaScript, and mode=auto decides for you.
- [Test](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/extraction/schema/test/index.md): test=true validates an extractscheme against a live URL before it is saved, and shows what each selector actually returned.
- [JS Automation](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/javascript-automation/index.md): jsinstructions clicks, fills and waits on a page before it is captured.
- [Network Capture](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/network-capture/index.md): Capture the XHR and fetch responses a page makes while it loads, filtered by resource type, URL, status, content type, method or header.
- [AI Enhancement](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/ai-enhancement/index.md): aienhance runs a model over the page's markdown or a screenshot to summarise it or return structured data, for an additional 30 credits per request.
- [Proxy Configuation](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/proxy/index.md): The Scraper API's proxy parameters, proxytype, proxycountry, proxysessionid and proxyoverwrite, and how residential and datacenter differ in cost and mode support.
- [Scraper API Parameter Usage Examples](https://docs.evomi.com/scraping-products-instructions/scraper-api/parameters/usage-examples/index.md): Scraper API requests with their credit cost attached, from a one-credit datacenter fetch to browser screenshots, PDFs and AI extraction.