Developers

Proxy reference

Gateway specification

Locations and sessions

Country, city, ASN, sticky-session lifetime and connection-level rotation in the v1 proxy contract.

Location selectors

Use country as a lowercase two-letter country code. Residential state, city and zip values require country. State and city names use lowercase underscore slugs, such as los_angeles. Use only values available in the activated gateway catalog.

Country and city
ch-ACCOUNT_ID-network-residential-country-us-city-los_angeles

ASN filtering

Use the numeric ASN without an AS prefix. Combine it with country only when matching inventory exists. ASN filtering is a residential selector in v1.

ASN selector
ch-ACCOUNT_ID-network-residential-country-us-asn-21928

Sticky sessions and lifetime

Add session to request continuity. The same account, selectors and session ID identify the same requested session. ttl is measured in seconds, defaults to 600, and accepts 60–3600. It is invalid without session.

A residential peer can become unavailable before the requested lifetime. The gateway must return a connection error rather than silently bypass the proxy. Session lifetime is not an uptime guarantee.

Ten-minute requested session
ch-ACCOUNT_ID-network-residential-country-us-session-job01-ttl-600

Rotation and persistent connections

Without session, the residential gateway selects an exit for a new upstream connection or CONNECT tunnel. A browser or HTTP client may reuse a persistent connection for multiple requests, so it is incorrect to promise a new IP for every page request. Open a new connection or session when your workflow requires a fresh selection.

Static networks

ISP and datacenter connections use assigned allocations. Select an owned allocation with ip. These networks accept country and ip in v1 and reject residential city, state, zip, ASN and session-lifetime selectors.

Dashboard setup drafts

The existing dashboard stores country, protocol and a session mode such as rotating, sticky or static. That saved UI draft is not the v1 wire username. In the gateway username, session is an identifier, not a mode. The activation/gateway adapter must perform that conversion.

Search documentation

Search guides, products and reference pages.