获取代理IP-帮助中心 - 小象代理 - 优质高速HTTP代理IP-爬虫-代理服务器

获取代理IP

更新时间： 2023-10-20 17:35:17

[TOC]

### 1. 接口描述

- 代理IP的提取接口。
- 适用产品：代理IP（短效版），代理IP（长效版）

### 2. 调用频率

- 默认1次/10秒

### 3. 请求URL

- `https://api.xiaoxiangdaili.com/ip/get`

### 4. 请求方式

- GET

### 5. 请求参数说明

|参数名|必选|参数说明|取值说明|
|:-----|:-----|:-----|-----|
| appKey |  <font style="color:#dd0000;">是</font> |  应用账号 | 产品管理页面查看 |
| appSecret |  <font style="color:#dd0000;">是</font> |  应用密钥 | 产品管理页面查看 |
| cnt | 否 | 提取数量 | 包时套餐默认值为应用的最大可提取数；包量套餐的默认值为1。 |
| wt | 否 | 响应体格式 | json或text，默认值：json |
| method | 否 | 代理协议 | http或s5（s5即socks5）,默认值：http |
| releaseAuto | 否 | 是否自动释放旧的IP | true或false，仅长效代理IP有效。当使用中（已提取未释放）的长效IP数量到达应用最大的可提取数，并且本参数设置为true时，系统自动释放旧的IP。如releaseProxy参数不为空，则优先释放releaseProxy指定的IP，否则按提取时间顺序优先释放最先提取的IP。 |
| releaseProxy | 否 | 待释放的代理IP | ip:port，多个以半角逗号分隔，仅长效代理IP有效。如本参数不为空，则在提取之前释放掉指定的IP。 |

### 6. 调用示例

```rust
GET https://api.xiaoxiangdaili.com/ip/get?
		appKey=950649340031422464
		&appSecret=q4adDKPC
```

### 7. 返回示例
```json
{
  "code": 200,
  "success": true,
  "data": [
    {
      "ip": "60.179.239.130",
      "port": 3000,
      "realIp": null,
      "startTime":"2022-01-01 18:00:00",
      "during": 2
    },
    {
      "ip": "121.228.80.144",
      "port": 3000,
      "realIp": null,
      "startTime":"2022-01-01 18:00:00",
      "during": 2
    }
  ],
  "msg": "操作成功"
}
```

### 8. 返回参数说明

#### 8.1 公共参数说明

|参数名|类型|说明|
|:-----  |:-----|-----  |
| code | int   | 状态码  |
| success | bool | 是否成功 |
| data | object | 返回业务参数 |
| msg | string | 信息 |

#### 8.2 业务参数说明（data）

|参数名|类型|说明|
|:-----  |:-----|-----                           |
| ip | string   | 代理服务器IP  |
| port | int   | 代理服务器端口  |
| realIp | string | 代理服务器真实出口IP（返回空时，出口IP即代理服务器IP） |
| startTime | string | 代理IP上线时间 |
| during | int | 代理IP存活时长（分钟） |

### 9. 状态码code说明

| code值 | 描述 |
|:-----  |:-----|
| 200 | 成功 |
| 1001 | 应用不存在 |
| 1002 | 应用已被冻结或禁用 |
| 1003 | 应用已过期 |
| 1004 | 连接池无响应 |
| 1005 | 应用不存在或已过期 |
| 1006 | 应用授权验证未通过 |
| 1007 | 提取量超过限制 |
| 1008 | 绑定的IP不一致 |
| 1009 | 无效的代理 |
| 1010 | 请求过于频繁 |
| 1012 | 产品类型不匹配 |
| 1014 | 应用剩余量不足 |
| 1200 | 参数格式错误 |
| 2000 | 未知异常 |

下一篇：查询剩余量