authToken
(string, required): your unique API authentication token. This must be included in all requests.Content-Type
: set to application/json
.Parameter | Type | Description |
---|---|---|
orderToken | string | A unique token linked to the user’s order. |
country | string | The country for which proxies are requested (e.g., “US”). |
numberOfProxies | integer | Specifies the number of proxies requested, if applicable. |
whiteListIP | array of strings | A list of IP addresses to be whitelisted for proxy access. |
enableSock5 | boolean | Set to true to enable SOCKS5 proxy support. |
planType | string | Indicates the type of plan. Options include: DEDICATED_DC , ISP , ISP_PREMIUM , SHARED_DC , RESIDENTIAL_SCRAPER . |
DEDICATED_DC
) plan offers exclusive access to data center proxies for optimized performance and reliability.
The following parameters are required for this plan type:
orderToken
, whiteListIP
, enableSock5
, country
Example Request:
orderToken
, whiteListIP
, numberOfProxies
, enableSock5
, country
Example Request:
ISP_PREMIUM
) plan offers top-tier ISP proxies with simplified configuration requirements.
The following parameters are required for this plan type:
orderToken
, whiteListIP
Example Request:
SHARED_DC
) plan offers cost-effective proxy solutions that are shared among multiple users.
The following parameters are required for this plan type:
orderToken
, whiteListIP
, numberOfProxies
, enableSock5
, country
Example Request:
RESIDENTIAL_SCRAPER
) plan grants access to residential IPs optimized for web scraping tasks.
The following parameters are required for this plan type:
orderToken
, whiteListIP
, numberOfProxies
, enableSock5
, country
Example Request:
proxies
: A list of proxy IPs generated based on your request parameters.200 OK
: Request completed successfully.400 Bad Request
: Some parameters are missing or invalid.403 Forbidden
: Authentication token is either invalid or missing.500 Internal Server Error
: An issue occurred on the server side.