Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Switch proxy settings for the browser scraper
| Parameter | Type | Description | Required |
|---|---|---|---|
| server | string | Proxy server address (host:port or URL) | Yes |
| timeout | number | Timeout in milliseconds | Yes |
| bypass | string | Comma-separated domains to bypass proxy (e.g., ".com, chromium.org") | No |
| linkOptions | LinkOptions | Get proxy from a LINK configuration | No |
| password | string | Password for HTTP proxy authentication | No |
| timezone | string | Timezone of the proxy in IANA format | No |
| username | string | Username for HTTP proxy authentication | No |
| Field | Type | Description | Required |
|---|---|---|---|
| consumerName | string | Name of the consumer using the link | Yes |
| countries | Array of string | Countries for the LINK target (ISO codes) | Yes |
| endpoint | string | Endpoint associated with LINK | Yes |
| isValidation | boolean | Whether the LINK target uses validation | Yes |
| targetId | string | Identifier for the LINK target | Yes |
| fallbackProxy | FallbackProxy | Optional fallback proxy | No |
| fingerprintId | number | Fingerprint identifier | No |
| labels | object | Metrics labels (key-value pairs) | No |
{
"command": "switch-proxy",
"params": {
"server": "proxy.example.com:8080",
"timeout": 10000,
"username": "user",
"password": "%{PROXY_PASSWORD}"
}
}
{
"command": "switch-proxy",
"params": {
"server": "proxy.link.example.com:8080",
"timeout": 10000,
"linkOptions": {
"consumerName": "scraper-1",
"countries": ["US"],
"endpoint": "proxy-endpoint",
"isValidation": false,
"targetId": "proxy-target-id"
}
}
}