Skip to main content
POST
Generates proxy lines from a residential or premium residential package you own, with location, session, pool, and mode parameters already encoded. It’s the API version of the dashboard’s proxy generator. Generating proxies doesn’t debit your balance. Bandwidth is only used when you send traffic through the proxies.

How the fields map to username parameters

This endpoint takes JSON fields, and writes the matching username parameters into every line it returns. The two are named differently, so here’s how they line up: So a request with "fast_mode": true gives you a proxy line whose username contains mode-fast. If you build lines yourself instead of calling this endpoint, use the username parameters directly — see the Residential proxies reference.
number
required
ID of the package to generate proxies for, from list packages.
number
Number of proxy lines to generate.
string
Output layout of each line: standard (host:port:username:password), secondary (username:password@host:port), http_url (http://username:password@host:port), or socks5_url (socks5://username:password@host:port).
string
HTTP or SOCKS5. When you use SOCKS5 with URL output, use the socks5_url format.
string
Session type. sticky adds session-<id> to the username, which keeps the same IP for session_time_minutes.
string
Two-letter country code to target, for example US. See Locations.
string
City to target within the country, for example newyorkcity.
string
Sub-pool to draw from. all uses the whole network. See Pools.
boolean
Fast mode: route through the peer with the lowest latency available. Sets mode-fast in the username of each generated line.
boolean
UDP mode: enable UDP traffic. Sets mode-udp in the username of each generated line.
number
For sticky proxies, how many minutes each session holds its IP. Sets time-<minutes> in the username of each generated line.

Response

number
Numeric package ID.
string
The package’s UUID.
string
ID of the sub-user behind this package.
string
Product: residential or premium_residential.
number
Number of proxy lines returned.
string[]
The generated proxy lines, in the requested format. Pass each one straight to your HTTP client.