> For the complete documentation index, see [llms.txt](https://doc.thordata.com/interface-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.thordata.com/interface-documentation/public-api/whitelist-ips/get-whitelist-ips-list.md).

# Get Whitelist IPs List

### Basic Information

**Interface Description:** Get the whitelist IP list of Thordata residential proxy, unlimited proxy server, and mobile proxy through the interface

**Interface URL:** <https://openapi.thordata.com/api/whitelisted-ips/ip-list>

**Request Method:** <mark style="color:green;">GET</mark>

### Request parameters

**Params：**

<table><thead><tr><th>Parameter name</th><th>Type</th><th width="127">Required</th><th>Describe</th></tr></thead><tbody><tr><td><code>token</code></td><td>string</td><td>Yes</td><td>Please log in to the  <a href="https://dashboard.thordata.com/account-settings"><strong>Dashboard-MENU-My Account</strong></a> to view your token parameter value</td></tr><tr><td><code>proxy_type</code></td><td>number</td><td>Yes</td><td>Select the proxy type: 1 is Residential Proxies, 2 is Unlimited Proxy servers,9 is Mobile Proxies(default is 1)</td></tr></tbody></table>

### Response example

```json
{
    "code": 200,
    "data": {
        "ip_count": 2,
        "limit": 100,
        "remaining_limit": 98
        "lists": [
            {
                "created_time": "2025-01-01",
                "ip": "1.1.1.1",
                "status": true
            },
            {
                "created_time": "2025-01-02",
                "ip": "2.2.2.2",
                "status": true
            }
        ],
    },
    "msg": "ok"
}
```

{% hint style="info" %}
If the returned code value is not 200, please check the [**error code description list**](https://doc.thordata.com/interface-documentation/error-code/error-code-description) and modify it.
{% endhint %}

<table><thead><tr><th width="206">Parameter name</th><th width="168">Type</th><th width="98">Required</th><th>Describe</th></tr></thead><tbody><tr><td><code>code</code></td><td>number</td><td>No</td><td>-</td></tr><tr><td><code>data</code></td><td>object</td><td>No</td><td>-</td></tr><tr><td><code>ip_count</code></td><td>number</td><td>Yes</td><td>Number of whitelisted IPs</td></tr><tr><td><code>limit</code></td><td>number</td><td>Yes</td><td>The maximum number of whitelist IPs that can be added</td></tr><tr><td><code>remaining_limit</code></td><td>number</td><td>Yes</td><td>Number of whitelist IPs remaining that can be added</td></tr><tr><td><code>created_time</code></td><td>string</td><td>Yes</td><td>Whitelist IP creation time</td></tr><tr><td><code>ip</code></td><td>string</td><td>Yes</td><td>Whitelist IP information</td></tr><tr><td><code>status</code></td><td>string</td><td>Yes</td><td>Whitelist IP status, true is enabled, false is disabled</td></tr><tr><td><code>msg</code></td><td>string</td><td>No</td><td>-</td></tr></tbody></table>