Skip to main content
POST
Build a rotating proxy connection
Run this request to generate a live connection.connectionString you can copy into an HTTP client, browser profile, or proxy checker. The subuserId field is optional. Omit it to use your account’s default proxy credentials, or see Manage Rotating Proxy Subusers when you need separate proxy groups or replacement credentials. For UDP, set protocol to socks5, choose residential or mobile, and set udp to true.

Authorizations

X-Api-Key
string
header
required

Client API key for the authenticated account.

Body

application/json
type
enum<string>
required

Proxy type

Available options:
residential,
mobile,
datacenter
Example:

"residential"

country
string
required

2-letter country code.

Pattern: ^[a-zA-Z]{2}$
Example:

"US"

subuserId
integer

Subuser ID from GET /v2/proxy/rotating/subusers. When omitted, the first account subuser is used.

Required range: x <= 9007199254740991
Example:

123

city
string

City name from GET /v2/proxy/rotating/locations. Spaces are encoded as underscores. Used only when state is not supplied.

Minimum string length: 1
Example:

"New York"

state
string

State or subdivision value from GET /v2/proxy/rotating/locations. When supplied, it takes precedence over city.

Minimum string length: 1
Example:

"CA"

asn
string

Target ASN as digits.

Pattern: ^\d+$
Example:

"15169"

rotation
default:15

Rotation value: -1 for each request, 0 for sticky, or interval minutes.

Example:

15

session
string
Required string length: 1 - 128
Example:

"my_session_1"

protocol
enum<string>
default:http
Available options:
http,
https,
socks5
Example:

"http"

udp
boolean
default:false

Route UDP traffic through the proxy. Supported only for SOCKS5 residential or mobile proxies.

Example:

false

Response

Generated rotating proxy connection details.

connection
object
required

Generated proxy connection. Use connection.connectionString as the primary copy-paste value.

parameters
object
required