获取开放代理IP
1. 接口描述
VIP https://dev.kdlapi.com/api/getproxy 英文代号:get proxy
SVIP https://svip.kdlapi.com/api/getproxy
实时获取开放代理IP列表。
- 必须使用订单API密钥调用本接口
- 接口最快调用频率:
普通用户
5秒1次
VIP用户
1秒1次
SVIP用户
1秒5次 - 接口IP白名单数量:
普通用户
1个
VIP用户
3个
SVIP用户
10个
2. 参数说明
参数 | 是否必填 | 参数说明 | 取值说明 |
---|---|---|---|
secret_id | 是 | 账户SecretId | 查看账户API密钥信息 |
sign_type | 否 | 签名验证方式。目前支持token和hmacsha1。 | 默认值:token |
signature | 是 | 请求签名,用来验证此次请求的合法性。 此接口默认需要验证签名 |
支持2种签名验证方式,签名计算方法参见API 授权与验证 |
timestamp | 否 | 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数为必填项。 |
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。 |
nonce | 否 | 随机正整数,与 timestamp 联合起来,用于防止重放攻击。建议携带此参数进一步提升API安全性。 sign_type=hmacsha1时此参数有效。 |
客户自行生成随机正整数,如random.randint(1, 100000000) |
num | 是 | 提取数量 | 普通 :1 ~ 500VIP :1 ~ 1000SVIP :1 ~ 2000 |
quality | 否 | 代理ip的稳定性 快代理不间断地监测每个代理ip的历史数据,根据算法智能判别当前的稳定性 |
0: 不筛选(默认) 1: VIP 较为稳定2: SVIP 稳定 |
area | 否 | ip所在地区,支持按 国家/省/市 筛选 | 多个地区用英文逗号分隔,如 北京,上海 |
area_ex | 否 | 排除某些地区 | 多个地区用英文逗号分隔,如 北京,上海 |
port | 否 | 按端口号筛选 | 多个端口号用英文逗号分隔,如 8080,18186 |
port_ex | 否 | 排除某些端口号 | 多个端口号用英文逗号分隔,如 8080,8000 |
carrier | 否 | ip所属运营商 | 0: 全部, 1: 联通/网通, 2: 电信, 3: 移动, 4: 铁通,5: 教育网,6: 阿里云 |
protocol | 否 | 按代理协议筛选 | 1: HTTP, 2: HTTPS(同时也支持HTTP) |
method | 否 | 按支持 GET/POST 筛选 | 1: 支持HTTP GET, 2: 支持 HTTP POST(同时也支持GET) |
ipstart | 否 | 筛选以特定部分开头的IP (多个IP段用英文逗号分隔) |
比如: 120.52. |
ipstart_ex | 否 | 排除以特定部分开头的IP (多个IP段用英文逗号分隔) |
比如: 120.52. |
dedup | 否 | 过滤今天提取过的IP | 取值固定为1 |
an_ha | 否 | 返回的代理中只包含高匿名代理 | 取值固定为1 |
an_an | 否 | 返回的代理中只包含匿名代理 | 取值固定为1 |
an_tr | 否 | 返回的代理中只包含透明代理 | 取值固定为1 |
sort | 否 | 返回的代理列表的排序方式 | 0: 默认排序 1: VIP SVIP 按响应速度(从快到慢)2: VIP SVIP 按最后检测时间(从近到远) |
f_loc | 否 | VIP SVIP 提取结果包含地区信息 |
取值固定为1 |
f_an | 否 | VIP SVIP 提取结果包含匿名度信息 |
取值固定为1 |
f_pr | 否 | VIP SVIP 提取结果包含代理协议信息目前支持的协议有HTTP和HTTPS(支持HTTPS的代理ip同时也支持HTTP) |
取值固定为1 |
f_sp | 否 | VIP SVIP 提取结果包含响应速度信息 |
取值固定为1 |
format | 否 | 接口返回内容的格式 | text: 文本格式(默认) json: VIP SVIP json格式xml : VIP SVIP xml格式 |
sep | 否 | 提取结果列表中每个结果的分隔符 | 1: \r\n分隔(默认) 2: \n分隔 3: 空格分隔 4: |分隔 |
3. 调用示例
在会员中心API密钥管理页得到订单的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08
- SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
调用示例
普通和VIP:
GET https://dev.kdlapi.com/api/getproxy?secret_id=o1fjh1re9o28876h7c08
&num=10
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
SVIP:
GET https://svip.kdlapi.com/api/getproxy?secret_id=o1fjh1re9o28876h7c08
&num=10
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数 | 说明 |
---|---|
code | 返回码。取值:0代表成功 非0代表失败 |
msg | 错误信息 |
data | 包含接口返回的数据 |
data.proxy_list | 返回的代理ip列表 |
data.count | 返回的代理ip数量 |
文本格式
正常返回代理列表,代理分隔符参见sep
参数,代理格式 ip:port
格式样例:
183.207.226.9:9999
120.197.85.171:33965
120.198.230.55:80
120.198.230.112:81
118.194.217.134:80
183.232.29.132:18204
异常返回错误码和错误提示,格式 ERROR(错误码): 错误提示
格式样例:
ERROR(-1): 参数错误
json格式
正常返回格式样例:
{
"msg": "",
"code": 0,
"data": {
"count": 10,
"proxy_list": [
"124.172.117.189:80",
"219.133.31.120:8888",
"183.237.194.145:8080",
"183.62.172.50:9999",
"163.125.157.243:8888",
"183.57.42.79:81",
"202.103.150.70:8088",
"182.254.129.124:80",
"58.251.132.181:8888",
"112.95.241.76:80"
]
}
}
异常返回格式样例:
{"code": -1, "msg": "参数错误", "data": ""}
xml格式
正常返回格式样例:
<?xml version="1.0" encoding="UTF-8"?>
<result>
<code>0</code>
<msg/>
<data>
<count>10</count>
<proxy_list>
<proxy>124.172.117.189:80</proxy>
<proxy>219.133.31.120:8888</proxy>
<proxy>183.237.194.145:8080</proxy>
<proxy>183.62.172.50:9999</proxy>
<proxy>163.125.157.243:8888</proxy>
<proxy>183.57.42.79:81</proxy>
<proxy>202.103.150.70:8088</proxy>
<proxy>182.254.129.124:80</proxy>
<proxy>58.251.132.181:8888</proxy>
<proxy>112.95.241.76:80</proxy>
</proxy_list>
</data>
</result>
异常返回格式样例:
<?xml version="1.0" encoding="UTF-8"?>
<result>
<code>-1</code>
<msg>参数错误</msg>
<data>
</data>
</result>
5. 错误码一览
错误码 | 说明 |
---|---|
2 | 订单已过期 |
3 | 没有找到符合条件的代理 |
-1 | 无效请求 |
-2 | 订单无效 |
-3 | 参数错误 |
-4 | 提取失败: $err_msg |
-5 | 独享代理订单不能提取开放代理 |
-6 | 私密代理订单不能提取开放代理 |
-7 | 隧道代理订单不能提取开放代理 |
-11 | 订单尚未支付 |
-12 | 订单无效 |
-13 | 订单已过期 |
-14 | 订单被封禁,请联系客服处理 |
-15 | 订单已过期 |
-16 | 订单已退款 |
-20 | 提取超时 |
-21 | 过滤今天提取过的IP,5秒内只能取1次 |
-22 | 提取频率超限 |
-23 | 普通订单一次提取不超过500个 |
-24 | 按响应速度排序是VIP功能,普通订单不能使用 |
-25 | 字段定制是VIP功能,普通订单不能使用 |
-26 | API返回$format_type格式是VIP功能,普通订单不能使用。 |
-31 | 普通订单不支持提取精选稳定代理,请升级VIP/SVIP |
-32 | SVIP订单才能提取精选超稳定代理,请升级后再提取 |
-33 | SVIP专属服务器仅供SVIP订单访问,请先升级 |
-35 | VIP订单一次提取不超过1000 |
-45 | SVIP订单一次提取不超过2000个 |
-51 | 此订单1分钟内允许最多$ip_number个ip调用 |
6. 生成API链接
您可以在线生成API链接,以便内置到您的程序或软件中。
生成API链接
7. SDK
快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。