开发者 API 文档

KiloProxy 提供完整的 RESTful API,支持普通用户查询/提取已购买的IP,以及代理商自动化创建订单与发货。所有接口均通过 HTTPS 访问,返回 JSON 格式数据。

介绍

API 基础地址:

Base URL: https://api.kiloproxy.com/v1

所有请求需要使用 HTTPS,请求与响应均为 application/json 格式。API 分为两套体系:

基础 API 供所有注册用户使用,用于查询和提取自己账户下的IP资源。代理商 API 仅限已开通代理资格的合作伙伴使用。

身份认证

所有接口请求需在 Header 中携带您的 API Key 进行身份认证。API Key 可在用户中心「开发者设置」页面获取。

Authorization: Bearer YOUR_API_KEY
请妥善保管您的 API Key,不要将其暴露在客户端代码或公开仓库中。如怀疑泄露,请立即在用户中心重置。

错误码说明

当请求出错时,接口会返回对应的 HTTP 状态码及错误信息:

400请求参数错误,请检查参数格式与必填项
401身份认证失败,API Key 无效或已过期
403无权限访问该接口(如普通用户调用代理商接口)
404请求的资源不存在
429请求频率超出限制,请降低调用频率后重试
500服务器内部错误,请稍后重试或联系技术支持

查询我的IP列表

获取当前账户下所有已购买的IP资源列表,支持按产品类型、状态筛选。

GET/v1/ips
请求参数
参数类型必填说明
product_typestring选填产品类型筛选:isp_native / isp_broadcast / datacenter / residential
statusstring选填状态筛选:active(生效中)/ expired(已过期)
pageinteger选填页码,默认为 1
page_sizeinteger选填每页数量,默认为 20,最大 100
200成功响应示例
{ "code": 0, "data": { "total": 12, "items": [ { "ip_id": "ip_8a3f2c", "product_type": "isp_native", "region": "US", "ip_address": "203.0.xxx.xxx", "port": 8080, "status": "active", "expire_at": "2026-07-18T00:00:00Z" } ] } }

获取IP详情

根据 IP ID 获取单条IP的完整详情,包括账密、协议类型等信息。

GET/v1/ips/{ip_id}
路径参数
参数类型必填说明
ip_idstring必填IP唯一标识,从「查询IP列表」接口获取
200成功响应示例
{ "code": 0, "data": { "ip_id": "ip_8a3f2c", "ip_address": "203.0.113.45", "port": 8080, "protocol": "socks5", "username": "user_xxx", "password": "pass_xxx" } }

批量提取IP

按指定格式批量导出账户下的所有IP,常用于一次性导入到指纹浏览器等第三方工具。

GET/v1/ips/export
请求参数
参数类型必填说明
formatstring选填导出格式:txt(默认)/ csv / json
delimiterstring选填txt格式分隔符,默认为冒号 ip:port:user:pass

查询流量用量

查询动态住宅代理产品的剩余流量与历史用量,仅适用于按流量计费的产品。

GET/v1/usage
200成功响应示例
{ "code": 0, "data": { "total_gb": 50, "used_gb": 12.4, "remaining_gb": 37.6 } }

创建订单(代理商)

代理商通过此接口为终端客户创建订单并自动发货,需使用代理商专属 Agent API Key。

POST/v1/agent/order/create
请求参数
参数类型必填说明
productstring必填产品代码,如 isp_native_us
quantityinteger必填购买数量
durationstring必填套餐周期,如 30d / 90d / 360d
client_refstring选填您系统内部的订单号,便于对账
200成功响应示例
{ "code": 0, "data": { "order_id": "ord_9f2c8a", "agent_price": "已按您的代理等级自动核算", "ips": ["ip_a1b2c3", "ip_d4e5f6"] } }

查询库存(代理商)

查询当前各产品线的可用库存数量,建议在创建订单前先调用此接口确认库存充足。

GET/v1/agent/stock

查询订单记录(代理商)

查询代理商账户下的历史订单记录,支持按时间范围、订单状态筛选。

GET/v1/agent/orders
请求参数
参数类型必填说明
start_datestring选填查询起始日期,格式 YYYY-MM-DD
end_datestring选填查询截止日期,格式 YYYY-MM-DD
遇到接口问题或需要更高的调用频率限制?欢迎联系我们的企业服务团队获取技术支持。 企业服务