Retrieve active proxy
To make the most out of this API endpoint, ensure you have a clear understanding of the types of proxies implemented within your network. Utilize the filtering options to retrieve precise and meaningful proxy data.
For further details on implementing this API, refer to the API documentation, which provides sample requests, response formats, and additional parameters you can use to tailor the data retrieval to.
Endpoint
Path parameters
Name | Value | Description |
|---|---|---|
Authorization |
| Your personal API key (how to get) |
Proxy type (optional) |
| The type of proxy you want to retrieve |
Please note that if no proxy type is specified, all available types will be returned for your profile.
Request params
Name | Type | Description |
|---|---|---|
latest | String | Y/N - Return proxy from last order |
orderId | String | Return a proxy from a specific orderId or baseOrderNumber |
country | String | Alpha3 country name (FRA or USA or ...) |
ends | String | Y - List of ending proxies |
Example
To retrieve proxies of all types:
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/proxy/listTo retrieve proxies of a specific type (e.g., IPv4):
https://proxy-seller.com/personal/api/v1/fj4948ffhg58gh843gh/proxy/list/ipv4Response
All types of proxies
{
"status": "success",
"data": {
"ipv4": [],
"ipv6": [],
"mobile": [],
"isp": [],
"mix": [],
"mix_isp": [],
"resident": [] //proxy lists
},
"errors": []
}One type of proxy
{
"status": "success",
"data": {
"items": [
{
"id": "0678564",
"order_id": "123456",
"order_number": "2000096_20240080",
"basket_id": "12345566",
"ip": "31.6.33.97",
"ip_only": "31.6.33.97",
"protocol": "HTTP",
"port_socks": 12345,
"port_http": 12345,
"login": "ruht5734hg",
"password": "gou5h437g",
"auth_ip": "",
"rotation": null,
"link_reboot": "#",
"country": "Belgium",
"country_alpha3": "BEL",
"status": "Active",
"status_type": "ACTIVE",
"can_prolong": true,
"date_start": "23.06.2024",
"date_end": "23.07.2024",
"comment": "",
"auto_renew": "N",
"auto_renew_period": ""
}
]
},
"errors": []
}Wrong type of proxy
{
"status": "error",
"data": null,
"errors": [
{
"message": "Could not find description of list{type} in CrmUserApiProxy",
"code": 22002,
"customData": null
}
]
}