POST
Generate proxies

Authorizations

Authorization
string
header
required

[just text field] Please enter token in following format: Bearer

Body

application/json
userId
string
required

The userId (username) of the sub-user to generate proxies for.

Example:

"test124"

proxyAmount
number
required

Number of proxies to generate. Must be a positive number.

Example:

10

country
string
required

ISO 3166-1 alpha-2 country code to generate proxies in.

Example:

"US"

state
string

Optional state/region to narrow down the proxy location within the country.

Example:

"California"

city
string

Optional city to narrow down the proxy location within the country/state.

Example:

"Los Angeles"

isSticky
boolean

Whether to generate sticky-session proxies that keep the same IP for the duration of sessionDuration. Defaults to false.

Example:

false

sessionDuration
number

Sticky session duration, in minutes. Only applies when isSticky is true; defaults to 30 minutes if isSticky is true and this is omitted.

Example:

30

proxyType
enum<string>

Proxy protocol to generate. Defaults to http.

Available options:
http,
socks5
Example:

"http"

format
enum<string>

Output format for the returned proxy connection strings. Defaults to ip:port:user:pass.

Available options:
ip:port:user:pass,
user:pass:ip:port,
user:pass@ip:port,
ip:port@user:pass
Example:

"ip:port:user:pass"

isp
string

Optional ISP (Internet Service Provider) to filter proxies by, if supported for the selected country.

Example:

"Comcast"

Response

Proxies generated