Get connection strings
Build ready-to-use proxy connection strings for a package, with targeting and session rules encoded for you. The returned credentials are used against the proxy gateway (proxy.soax.com:1337) — not against this API.
Location parameters are validated against what the package can actually target: an unavailable country, region, city, ISP, ASN, or ZIP returns 400. region, city, isp, asn, and zip all require country to be set.
Rotation and error handling: rotate-time and rotate-requests are mutually exclusive; on-error=retry requires retries, and retries is only valid with on-error=retry; bind=node is incompatible with prefer=lookalike and on-error=replace. When any rotation/error/bind rule is used (or count > 1) and no session is given, a session ID is generated automatically; with count > 1 the session IDs are numbered so each connection string gets its own IP.
For packages using IP allowlist authentication, rules are encoded in the hostname (HTTPS only), username is empty, and password is null.
Requires the proxy:packages:read scope.
Authorizations
API key secret (starts with s_live_). Create keys in the dashboard under Settings → API keys, or via POST /v1/api-keys/. Send it as Authorization: Bearer <secret>.
Path Parameters
The ID of the proxy package (UUID format)
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Query Parameters
Protocol to build the string for. Must be enabled on the package; IP-auth packages support https only. If omitted, the uri is returned without a scheme prefix.
https, http, socks5 Number of connection strings to return (1–1000). Each gets a numbered session ID so it maps to a distinct IP.
1 <= x <= 1000Restrict to a network type.
residential, mobile, any Two-letter ISO country code to target (e.g. us). Required when region, city, isp, asn, or zip is set.
Region to target. Use codes from the package regions endpoint. Requires country.
City to target. Use codes from the package cities endpoint. Requires country.
ISP to target. Use codes from the package ISPs endpoint. Requires country.
ASN to target (e.g. AS7922). Requires country and the ASN targeting feature on your plan.
ZIP/postal code to target. Requires country and the ZIP targeting feature on your plan.
Routing preference. lookalike prefers replacement nodes with similar characteristics (same region/ISP) when a node is rotated or replaced.
lookalike Rotate to a new IP after this many seconds. Mutually exclusive with rotate-requests.
Rotate to a new IP after this many requests. Mutually exclusive with rotate-time.
What to do when the current node fails: replace picks a new node (default behavior), retry retries the same node (retries required), fail returns the error to your client.
replace, fail, retry Number of retry attempts on the same node before replacement. Only valid with on-error=retry.
Custom session ID: lowercase letters and digits, up to 16 characters. Requests sharing a session ID keep the same IP. If omitted, a session ID is generated automatically when rotation, error handling, bind, or count > 1 requires one.
^[a-z0-9]{1,16}$node locks the session to a single node: if the node fails, requests fail instead of being moved to a new IP. Incompatible with prefer=lookalike and on-error=replace.
node