查询剩余量-帮助中心 - 小象代理 - 优质高速HTTP代理IP-爬虫-代理服务器

查询剩余量

更新时间： 2023-09-12 16:10:13

[TOC]

### 1. 接口描述

- 查询包量套餐的可提取IP剩余量。
- 适用产品：代理IP（短效版）（仅包量套餐）

### 2. 调用频率

- 1次/秒

### 3. 请求URL

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

### 4. 请求方式

- GET

### 5. 请求参数说明

|参数名|必选|参数说明|取值说明|
|:-----|:-----|:-----|-----|
| appKey |  <font style="color:#dd0000;">是</font> |  应用账号 | 产品管理页面查看 |
| appSecret |  <font style="color:#dd0000;">是</font> |  应用密钥 | 产品管理页面查看 |

### 6. 调用示例

```rust
GET https://api.xiaoxiangdaili.com/ip/remaining?
		userKey=950649340031422464
		&userSecret=q4adDKPC
```

### 7. 返回示例
```json
{
    "code": 200,
    "success": true,
    "data": {
        "appKey": 950649340031422464,
        "total": 500,
        "remaining": 260
    },
    "msg": "操作成功"
}
```

### 8. 返回参数说明

#### 8.1 公共参数说明

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

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

|参数名|类型|说明|
|:-----  |:-----|-----                           |
|appKey |int   | 应用账号  |
|total |int   | 总量  |
|remaining |int   | 剩余量  |

### 9. 状态码code说明
| code值 | 描述 |
|:-----  |:-----|
| 200 | 成功 |
| 1001 | 应用不存在 |
| 1002 | 应用已被冻结或禁用 |
| 1003 | 应用已过期 |
| 2000 | 未知异常 |

上一篇：获取代理IP

下一篇：绑定白名单