全球-独享代理（地区锁）-查询通道
## 海外独占-查询通道
`https://overseas.proxy.qg.net/channels`
### 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
### 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------ | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Object | 通道信息对象，包含 total（通道总数）与 idle（空闲通道数）。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
### 输入示例
```
GET https://overseas.proxy.qg.net/channels?key=<您的key信息>
```
### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"total": 5,
"idle": 4
},
"request_id": "22904b81-1a7e-4402-a981-0955f0ed157d"
}
```
---
##
全球-独享代理（地区锁）-查询在用资源
## 海外独占-查询在用资源
`https://overseas.proxy.qg.net/query_monopolize`
### 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| uuid | 否 | String | 查询指定的独占资源。 |
### 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of Monopoly | 在用资源列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
### 输入示例
```
GET https://overseas.proxy.qg.net/query_monopolize?key=<您的key信息>&<其他输入参数>
```
### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"uuid": "jike-hk:ppp497",
"area": "日本",
"area_code": 992600,
"state": "在线",
"ip": "45.131.177.11:20500",
"real_ip": "106.73.200.32",
"heartbeat": "2026-06-12 15:12:33",
"monopolize_time": "2026-06-12 15:08:31"
}
],
"request_id": "b97aa60a-458c-4c3d-92f1-16762c5226ef"
}
```
---
##
全球-独享代理（地区锁）-提取资源接口
## 海外独占-提取资源
`https://overseas.proxy.qg.net/monopolize`
### 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------- | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area | 否 | Integer | 按地区提取。 |
| num | 否 | Integer | 提取数量。默认：1 |
### 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of Monopoly | 独占资源列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
### 输入示例
```
GET https://overseas.proxy.qg.net/monopolize?key=<您的key信息>&<其他输入参数>
```
### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"uuid": "jike-hk:ppp497",
"area": "日本",
"area_code": 992600,
"state": "等待中",
"monopolize_time": "2026-06-12 15:08:31"
}
],
"request_id": "a6e4392e-f045-4755-b584-bbf4bb8bede6"
}
```
---
##
短效代理（全球HTTP）-按量提取-提取IP资源接口
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/get) 用于全球HTTP-短效代理产品 按量提取模式下提取IP的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。
需注意，如使用白名单IP，请在提取前添加白名单。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------- | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area | 否 | String | 国家筛选。支持国家编码和自定义编码，比如：US,EU，或者990100,990200。[国家编码](https://www.qg.net/doc/use/8_234_201/1975.html) |
| area_ex | 否 | String | 排除某些地区提取。使用方式同上 |
| num | 否 | Integer | 提取个数，默认为1 |
| keep_alive | 否 | Integer | 存活时长，在存活周期范围内，默认最短 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/get?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [{
"proxy_ip": "129.150.42.240",
"server": "129.150.42.240:18080",
"area": "新加坡",
"deadline": "2023-02-25 15:38:36"
}],
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyipResource)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
| BALANCE_INSUFFICIENT | Key余额不足。 |
| NO_RESOURCE_FOUND | 资源不足。 |
| FAILED_OPERATION | 提取失败。 |
| EXTRACT_LIMIT_EXCEEDED | 超出提取配额。 |
短效代理（全球HTTP）-按量提取-查询余额接口
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/balance) 用于全球HTTP-短效代理产品按量提取模式下查询余量的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ------------ | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.balance | Integer | key的流量余量。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/balance?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"balance": 9999
},
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyipResource)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
短效代理-通道提取-提取IP接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/get) 用于短效代理产品通道提取模式下提取IP的接口。
默认接口请求频率限制：（通道数*5+10）次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------- | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area | 否 | String | 按地区提取。支持多地区筛选，逗号隔开。比如："350500,330700"。 |
| area_ex | 否 | String | 排除某些地区提取。支持多地区排除，用逗号隔开。比如："440100,450000"。 |
| isp | 否 | Integer | 按运营商提取。
0: 不筛选
1: 电信
2: 移动
3: 联通 |
| num | 否 | Integer | 提取个数，默认为1。 |
| distinct | 否 | Bool | 去重提取，默认为false。如果为true则不会提取到已经在使用的IP资源。 |
##### 请注意，指定和排除地区，最多支持5个。
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/get?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"proxy_ip": "123.54.55.24",
"server": "123.54.55.24:59419",
"area": "河南省商丘市",
"isp": "电信",
"deadline": "2023-02-25 15:38:36"
}
],
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
| BALANCE_INSUFFICIENT | Key余额不足。 |
| NO_RESOURCE_FOUND | 资源不足。 |
| FAILED_OPERATION | 提取失败。 |
| EXTRACT_LIMIT_EXCEEDED | 超出提取配额。 |
独享代理-释放IP资源接口
## 1. 接口描述
接口请求域名： exclusive.proxy.qg.net。
本接口 (/delete) 用于独享代理产品释放IP资源的接口。
默认接口请求频率限制：每分钟时间内，单通道最多可释放2次IP。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| task | 否 | String | 按提取批次释放。支持批量释放，用逗号隔开。比如：Z5p2DKKCSyhocKEa,xsQGWfoaX99WcYnU。 |
| ip | 否 | String | 按IP释放。支持批量释放，用逗号隔开。比如：129.123.7.89,23.11.112.51。 |
**注意：
1、task和ip必选其一，如果两个参数都填写，以task为准。
2、如果需要释放全部IP，用task="\*"或者ip="\*"即可。
3、这里的释放参数ip为提取接口返回的proxy_ip值**
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------ | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://exclusive.proxy.qg.net/delete?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
| DELETE_LIMIT_EXCEEDED | 释放频率超出限制。 |
查询白名单IP
## 1 接口描述
接口地址：
**国内代理**：https://proxy.qg.net/whitelist/query
**全球HTTP**：https://overseas-api.proxy.qg.net/whitelist/query ；
本接口用于查询IP的白名单。
该接口单个Key的请求频率限制为：60次/分钟；
方法：HTTP、GET，需要注意不能混合使用；
编码：参数和返回内容均采用utf-8编码。
## 2 输入参数说明
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |查询白名单的Key值
|TaskID |是 |Integer |任务编号ID
|detail |是 |Integer |详情0(关闭) 1(开启)
## 3 返回值
接口可返回文本格式、json格式、xml格式，字段说明如下：
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer |结果编码，0：成功；-1：失败
|Num |Integer |数量
|Data |Array |IP白名单列表
## 4 示例
请求接口示例：
```
curl "https://proxy.qg.net/whitelist/query?Key=请改成您的Key"
```
返回示例：
```
{
"Code": 0,
"Num": 2,
"Data": [
"192.168.1.1",
"192.168.1.2"
]
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| ------------ | ------------ |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
删除白名单IP
## 1 接口描述
本接口用于删除IP的白名单。接口请求地址为
**国内代理**：https://proxy.qg.net/whitelist/del
**全球HTTP**：https://overseas-api.proxy.qg.net/whitelist/del ；
**注：**该接口单个Key的请求频率限制为：20 次/分钟。
## 2 输入参数说明
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |删除白名单的Key值|
|IP |是 |String|白名单IP，多个以逗号", "分隔|
## 3 返回值
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer |结果编码|
|Data |Array|删除成功的白名单数组|
|Num |Integer |删除成功的白名单个数|
## 4 示例
请求参数：
```
curl "https://proxy.qg.net/whitelist/del?Key=请改成您的Key&IP=1.1.1.1,2.2.2.2"
```
返回参数，JSON格式，详情如下：
```
{
"Code": 0,
"Data": [
"1.1.1.1",
"2.2.2.2"
],
"Num": 2
}
```
## 5 接口返回错误码
|错误码|描述|
|:---- |:----- |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
添加白名单IP
## 1 接口描述
接口地址：
**国内代理**：https://proxy.qg.net/whitelist/add
**全球HTTP**：https://overseas-api.proxy.qg.net/whitelist/add
本接口用于添加IP的白名单。
该接口单个Key的请求频率限制为：20次/分钟；
方法：HTTP、GET，需要注意不能混合使用；
编码：参数和返回内容均采用utf-8编码。
## 2 输入参数说明
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |添加白名单的Key值|
|IP |是 |Integer|白名单IP,多个以逗号","分隔|
## 3 返回值
接口可返回文本格式、json格式、xml格式，字段说明如下：
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer | 结果编码 |
|Data |Array | 添加成功的白名单IP |
|Num |Integer |添加成功的数量 |
## 4 示例
请求接口示例：
```
curl "https://proxy.qg.net/whitelist/add?Key=请改成您的Key&IP=1.1.1.1,2.2.2.2"
```
返回示例：
```
{
"Code": 0,
"Data": [
"1.1.1.1",
"2.2.2.2"
],
"Num": 2
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| ------------ | ------------ |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
| -202 | 白名单数量超过限制 |
