> For the complete documentation index, see [llms.txt](https://help.1024proxy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.1024proxy.com/1024/1024proxy/dynamic-residential-traffic/api.md).

# API

### 1024Proxy API功能介绍

API功能为有编程能力的用户提供了更加便捷的操作方式。可以通过修改API参数快速筛选提取自己需要的代理IP。使用1024Proxy API更常被应用于数据抓取等需要高频切换IP的业务场景。

### 快速了解

<figure><img src="/files/JYZM3b2NDifl27exSeBV" alt=""><figcaption></figcaption></figure>

### 如何使用1024Proxy的API功能

{% stepper %}
{% step %}

### 添加本地公网IP至IP白名单，点击按钮【添加白名单】

<figure><img src="/files/58CMpHf3Tk1ZUcT6QIDN" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/zPxs3cNsxbtgsX18sP0C" alt=""><figcaption></figcaption></figure>

{% endstep %}

{% step %}

### 完成动态住宅流量套餐的购买

返回API模式菜单下，选中动态住宅流量，我们可以查看到当前已经添加我们的本地公网IP至IP白名单中。点击立即购买跳转到套餐购买页，完成动态住宅流量的套餐购买。

<figure><img src="/files/VCPB0wKMlxms5X6g6nMR" alt=""><figcaption></figcaption></figure>

选择需要的套餐类型

<figure><img src="/files/QLjdif02e2LEPCbw1gkF" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### 设置筛选条件或者参数

完成购买后点击进入控制台进入API模式，

![](/files/n3vQBjnSRViaX9wf7e4z)

可以查看到我们购买的动态住宅流量及当前账号中剩余的流量。

<figure><img src="/files/iDrZlsFmnKcIZ0xyjD7U" alt=""><figcaption></figcaption></figure>

通过修改下面的参数完成API的基础设置后即可使用API链接批量修改提取自己需要的IP。

<figure><img src="/files/eesdv1RCQ2JbpSJRZarI" alt=""><figcaption></figcaption></figure>

1.国家/地区：通过下拉框修改国家代码即可修改API链接对应的region参数，下拉选择的可视化操作方便小白用户操作。

2.分隔符：1024Proxy支持多种API分隔符，能够适用于多种业务场景。

3.会话类型：1024Proxy包含两种会话类型：粘性会话模式（Sticky mode）和轮换会话模式（Rotating mode），在动态住宅流量的粘性会话模式下，会话时长为10/15分钟。选择粘性会话模式，则API将多一个time参数。

4.数据格式：这里的数据格式是指，API返回的数据对应着不同的数据返回数据格式。在1024Proxy官网展示着对应的数据返回示例。在API参数中对应的参数为type。

5.数量：这里的数量表示的API链接提取的IP数量，对应的API 修改参数为num。

6.API链接：通过修改对应的参数可以修改IP的提取条件。复制API链接到编程程序或者第三方代理软件中即可使用。

7.返回示例：返回的示例数据格式对应上述的txt和json两种数据格式的返回数据示例。
{% endstep %}
{% endstepper %}

### 参数注释

| 参数名    | 说明                     | 类型     | 必选 |
| ------ | ---------------------- | ------ | -- |
| region | 国家                     | int    | 是  |
| format | 返回数据格式分割符，n=\n rn=\r\n | string | 是  |
| time   | 会话时长                   | int    | 是  |
| num    | 提取 IP 数量               | string | 否  |
| type   | 数据格式：txt json          | string | 否  |