Retrieve active proxy by type
Returns active proxies for one proxy type. The `resident` type returns resident list items instead of regular IP address records. Pagination is supported only for this typed endpoint. When `page` or `per_page` is provided, `data.items` contains only the requested page and `data` includes `page`, `per_page`, `total`, and `total_pages`. When both pagination parameters are omitted, the response keeps the legacy shape and returns all items without pagination metadata.
Path Parameters
Client API key.
Proxy type.
"ipv4" | "ipv6" | "mobile" | "isp" | "mix" | "mix_isp" | "resident" | "subresident"Query Parameters
Set to Y to return proxies from the latest active order.
"Y" | "N"Filter by order ID or base order number.
Filter by Alpha-3 country code.
3 <= length <= 3Set to Y to return proxies with the ending status.
"Y" | "N"1-based page number for typed proxy list responses. If omitted while per_page is provided, defaults to 1.
1 <= valueNumber of items per page for typed proxy list responses. If omitted while page is provided, defaults to 100.
1 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://proxy-seller.com/personal/api/v2/abc123/proxy/list/ipv4?latest=Y&orderId=123456&country=USA&ends=Y&page=1&per_page=100"{
"data": null,
"errors": [
{
"code": 22002,
"message": "Could not find description of list/unknown_type in CrmUserApiProxy",
"customData": null
}
],
"status": "error"
}{
"code": 400,
"message": "Bad request",
"customData": null
}{
"error": "Too many requests"
}