Skip to main content
GET
Get proxy connection strings

Authorizations

Authorization
string
header
required

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

package_id
string
required

The ID of the proxy package (UUID format)

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

protocol
enum<string> | null

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.

Available options:
https,
http,
socks5
count
integer
default:1

Number of connection strings to return (1–1000). Each gets a numbered session ID so it maps to a distinct IP.

Required range: 1 <= x <= 1000
network
enum<string> | null

Restrict to a network type.

Available options:
residential,
mobile,
any
country
string | null

Two-letter ISO country code to target (e.g. us). Required when region, city, isp, asn, or zip is set.

region
string | null

Region to target. Use codes from the package regions endpoint. Requires country.

city
string | null

City to target. Use codes from the package cities endpoint. Requires country.

isp
string | null

ISP to target. Use codes from the package ISPs endpoint. Requires country.

asn
string | null

ASN to target (e.g. AS7922). Requires country and the ASN targeting feature on your plan.

zip
string | null

ZIP/postal code to target. Requires country and the ZIP targeting feature on your plan.

prefer
enum<string> | null

Routing preference. lookalike prefers replacement nodes with similar characteristics (same region/ISP) when a node is rotated or replaced.

Available options:
lookalike
rotate-time
integer | null

Rotate to a new IP after this many seconds. Mutually exclusive with rotate-requests.

rotate-requests
integer | null

Rotate to a new IP after this many requests. Mutually exclusive with rotate-time.

on-error
enum<string> | null

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.

Available options:
replace,
fail,
retry
retries
integer | null

Number of retry attempts on the same node before replacement. Only valid with on-error=retry.

session
string | null

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.

Pattern: ^[a-z0-9]{1,16}$
bind
enum<string> | null

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.

Available options:
node

Response

Successful Response

uri
string
required
username
string
required
host
string
required
port
integer
required
password
string | null