> 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/api-extract-links/residential-proxies.md).

# Residential Proxies

### Basic Information

**nterface Description:** Get Residential Proxies IP through interface

**Interface URL:** <https://get-ip.thordata.net/api>

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

{% hint style="info" %}
**Please note**: Before using the API link, you need to add the user's IP to the IP whitelist, [**Click here**](https://doc.thordata.com/doc/proxies/residential-proxies/endpoint-generator/whitelisted-ips/api-link) to learn how to add an IP whitelist
{% endhint %}

### Request parameters

**Params：**

| Parameter name | Type   | Required | Describe                                                                                                                                                  |
| -------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `td-customer`  | string | Yes      | Configure your Username, Please log in to the [**Dashboard - MENU - My Account** ](https://dashboard.thordata.com/account-settings) to view your Username |
| `sesstype`     | string | Yes      | Configure the session type: 1 is a sticky session, 2 is a rotating session.                                                                               |
| `number`       | number | Yes      | Configure the number of extracted IPs                                                                                                                     |
| `country`      | string | Yes      | Configure the country/region code that needs to be extracted                                                                                              |

{% hint style="info" %}
[**Click here**](https://doc.thordata.com/doc/proxies/residential-proxies/country-region-list) for a list of supported countries/regions and code.
{% endhint %}

### Response example

{% hint style="info" %}
**Please note:** The displayed IP is not the actual IP used, so the displayed IP is the same. When actually used, different ports are used and the IPs are different.
{% endhint %}

```
43.130.47.112: 19914
43.130.47.112: 14453
43.130.47.112: 17679
43.130.47.112: 14613
43.130.47.112: 11747
```

### **Error code description**

| Error Code | Return                                                    | Describe                         |
| ---------- | --------------------------------------------------------- | -------------------------------- |
| 111        | Please request again in 2 seconds                         | Extraction frequency is too fast |
| 118        | Your account is abnormal, please contact customer service | Incorrect Username               |
| 114        | The extracted IP is empty                                 | No IP matches the criteria       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.thordata.com/interface-documentation/public-api/api-extract-links/residential-proxies.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.