# 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       |