> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bentoo.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Proxy List Retrieval Interface

### Function

Obtains available residential proxy resources for the current account, including IP, port, username and password, IP validity, and other information. The Traffic Plan supports filtering by country/region.

### Applicable Scenarios

Bulk extraction of proxy IPs for businesses such as web crawling and multi-account login.

### Call Information

* **Request URL**: `https://api.xxx.com/proxies/list`
* **Request Method**: `GET`
* **Request Header**: `Authorization: Bearer [Your API Key]`

### Parameter Description (Optional Parameters, Add as Needed)

| Parameter Name | Type    | Description                                                                                                        | Applicable Plan   |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | ----------------- |
| `region`       | String  | Country/region code (e.g., `US` = United States, `BR` = Brazil, `CN` = China). Multiple codes separated by commas. | Traffic Plan Only |
| `count`        | Integer | Number of proxies obtained per call (default: 10, maximum: 50).                                                    | All Plans         |

### Example (Traffic Plan: Obtain 10 US IPs)

* **Request URL**: `https://api.xxx.com/proxies/list?region=US&count=10`

### Successful Response Example (Status Code: 200)

```json theme={null}
{
  "code": 200,
  "msg": "Retrieval successful",
  "data": [
    {
      "ip": "192.168.1.101",
      "port": 8080,
      "username": "proxy_user_01",
      "password": "proxy_pwd_01",
      "region": "United States",
      "region_code": "US",
      "valid": true,
      "expire_time": "2025-12-31 23:59:59"
    }
    // Remaining 9 proxy entries...
  ]
}
```

### Failed Response Example (Insufficient Permissions, Status Code: 403)

```json theme={null}
{
  "code": 403,
  "msg": "Insufficient permissions. The Unlimited Plan does not support region filtering.",
  "data": null
}
```