Request parameters
A single reference for everything you can set on a proxy request. Set values
either in the proxy username or with X-Proxy-* headers; headers win.
Parameters
Section titled “Parameters”| Username param | Header | Values | Default |
|---|---|---|---|
region |
X-Proxy-Region |
region prefix, e.g. eu, eu.west |
any |
cc |
X-Proxy-Country |
ISO country code, e.g. de |
any |
iptype |
X-Proxy-IPType |
datacenter · residential · mobile |
any |
protocol |
X-Proxy-Protocol |
e.g. http, socks5 |
any |
strategy |
X-Proxy-Strategy |
see strategies below | plan default |
session |
X-Proxy-Session |
any stable string | — |
strict |
X-Proxy-Strict |
true · false |
false |
Username encoding
Section titled “Username encoding”The API key is the whole username; params (if any) follow it. No password.
<api-key>[-<param>-<value>]...YOUR_API_KEY-region-eu.west-cc-de-iptype-residential-strategy-freshest_ipMatching: region is a hierarchical prefix; cc, iptype, and protocol
are exact.
Strategy values
Section titled “Strategy values”| Value | Notes |
|---|---|
round_robin |
Default-style even rotation. |
weighted_round_robin |
Weighted by node capacity. |
least_connections |
Fewest in-flight. |
lowest_latency |
Best measured latency. |
random |
Uniform random. |
ip_hash |
Stable per client IP. |
session_affinity |
Pinned by session. |
freshest_ip |
Least-recently-used IP per (org, host). |
ip_rotation |
Deterministic rotation per (org, host). |
cost_aware |
Prefer cheaper egress. |
See Routing strategies for guidance.
IP types
Section titled “IP types”| Value | Description |
|---|---|
datacenter |
Cloud/datacenter IPs — fast and cheap. |
residential |
Real ISP IPs. |
mobile |
Carrier mobile IPs. |
Status codes
Section titled “Status codes”| Code | Meaning |
|---|---|
200+ |
Target’s response, proxied back verbatim. |
403 |
Plan violation (disallowed region/ip_type) or hard limit. |
407 |
Proxy auth required — bad, missing, or revoked API key. |
429 |
Org concurrency / rate limit exceeded. |
502 |
Node failed to execute the request. |
504 |
Outbound request timed out. |
Precedence rules
Section titled “Precedence rules”- Plan limits are applied first — they can reject the request outright.
X-Proxy-*headers override username-encoded params.strictdecides whether an unsatisfiable constraint fails (true) or falls back (false).- All
Proxy-AuthorizationandX-Proxy-*headers are stripped before the request leaves the node.