Skip to content

On Residential/Mobile, country, city and session_ttl produce a ready-to-use username for a country/city-targeted or sticky-IP connection. HTTP and SOCKS5 run at the same time on separate ports.

targeting shows the values actually applied. If country is not sent, the order's default country is used; the city is simplified when it is written into the username (ist-anbul → istanbul). Each call creates a new session.

The username and password in examples.socks5 come percent-encoded for use in a URL; you can copy them and use them as they are.

Authorization

Authorizationstringrequired

Sent as Bearer <token>. This endpoint needs the proxies:read (Proxy list) scope; a token without it gets 403.

Path parameters

idstringrequired

The service ID. Take it from the id field of the GET /orders response.

Query parameters

countrystring

Residential/Mobile: exit country, a real ISO country code (e.g. tr). Invalid codes such as xx return 400.

citystring

Residential/Mobile: city (e.g. istanbul). Used together with country.

session_ttlenum<string>

Residential/Mobile: sticky IP duration in seconds: 30, 60, 1800, 3600 or 86400. If not sent, each connection gets a new IP.

Response

200
application/json
dataobject