Authorizations
Private API key for user-level authentication.
Public API key for user-level authentication.
Query Parameters
Number of proxies to return in the list.
1 <= x <= 1000
Desired format for the proxies (e.g., "http", "socks5", "socks5h", or "standard").
standard
, http
, socks5
, socks5h
ID of the proxy_user you want to use to authenticate with the proxies.
Session type of the residential proxies you want returned in the search list.
sticky
, rotating
ISO Country Code (ISO 3166-1 alpha-2) to generate residential proxies in.
ID of the City to generate residential proxies in.
Alias of the City to generate residential proxies in.
ID of the Zip Code to generate residential proxies in.
ID of the US Subdivision to generate the residential proxies in.
Is SmartPath enabled for the residential proxies you want returned in the search list.
The session ttl of the residential proxies you want returned in the search list
Desired mode for residential network optimization
general
, size
, speed
Response
Residential list successfully generated.
The response is of type object
.