Skip to content

WebSocket Parameters

Use these query parameters on the CDP WebSocket URL to configure your Evomi Scraping Browser sessions.

Base Format Permalink to Base Format

wss://browser.evomi.com?key=YOUR_API_KEY[&param=value...] 
Always keep your API key secret. Rotate keys from your dashboard if exposed.

Parameters Permalink to Parameters

Name Type Example Default Description
key string key=evm_123... β€” (required) Your Evomi API key authorizing the browser session
os enum os=windows provider default Target OS fingerprint: windows, macos, android
proxy_country ISO 3166-1 alpha-2 proxy_country=US dynamic Route traffic via integrated proxy for the specified country
proxy_state string proxy_state=california none Target a state/province within the proxy country. Lowercase, dots for spaces (new.york, southern.cape); display names like New York are normalized automatically. 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
proxy_city string proxy_city=san.jose none Target a specific city. Same format rules as proxy_state. Any well-formed value is passed through β€” unsupported locations fail at the proxy. Supported values are listed in the Evomi settings API
language string (tag list) language=de-CH,de follows proxy IP Browser languages & locale as comma-separated tags (max 128 chars, no q-values). Default: the browser follows the proxy IP / profile locale automatically
timezone string (IANA zone) timezone=Asia/Tokyo derived from proxy_country Browser clock as an IANA timezone name (max 64 chars, must be a real zone β€” invalid values reject the connection). Default: the proxy country’s primary zone, e.g. US β†’ America/New_York, DE β†’ Europe/Berlin, JP β†’ Asia/Tokyo
adblock boolean adblock=true false Enable built‑in ad/tracker blocking for cleaner pages and fewer popups
solve_cloudflare boolean solve_cloudflare=false true Toggle automatic Cloudflare Turnstile solving
Parameters are optional unless marked required. Unrecognized parameters are ignored; language and timezone are validated and invalid values reject the connection.

Examples Permalink to Examples

# Windows fingerprint, US proxy routing, adblock on
wss://browser.evomi.com?key=YOUR_API_KEY&os=windows&proxy_country=US&adblock=true

# Disable Turnstile solving for debugging
wss://browser.evomi.com?key=YOUR_API_KEY&solve_cloudflare=false

# German (Switzerland) locale regardless of proxy location
wss://browser.evomi.com?key=YOUR_API_KEY&proxy_country=US&language=de-CH,de

# Tokyo clock regardless of proxy location
wss://browser.evomi.com?key=YOUR_API_KEY&proxy_country=US&timezone=Asia/Tokyo

# City-level routing: San Jose, California exit
wss://browser.evomi.com?key=YOUR_API_KEY&proxy_country=US&proxy_state=california&proxy_city=san.jose

# Minimal: just your key
wss://browser.evomi.com?key=YOUR_API_KEY

Behavior Notes Permalink to Behavior Notes

  • Sessions are ephemeral; reconnect to create a fresh environment.
  • Managed browser compatibility features are enabled by default and require no code changes.
  • Integrated proxy usage and CAPTCHA solving may affect usage accounting.
  • With your own proxy (proxy=) and no timezone given, the clock defaults to US Eastern (America/New_York) β€” pass timezone or proxy_country to set it explicitly.
  • proxy_country, proxy_state and proxy_city do not apply when using your own proxy (proxy=). 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.
Combine parameters to match your testing environment. Example: os=windows&proxy_country=US&adblock=true.