View Categories

IPNut 开发者API文档

1、API调用示例 #

示例说明：

以【地区查询】API请求路径为：https://open.ipnut.com/v1/area/list

API请求域名为：https://open.ipnut.com，

地区查询Path： /v1/area/list，Method： GET

请求header固定包含 api-token（代理密钥），api-id（用户ID）获取方式：成为合作伙伴，联系客户经理获得，单账户的请求频率限制为 1分钟内 60次

2、调用说明 #

API请求路径为：https://open.ipnut.com

请求header固定包含 api-token（代理密钥），api-id（用户ID）

post请求为form-data格式

单账户的请求频率限制为 1分钟内 60次

结果码示例：

0成功
60400参数出错
60401授权失败
60300余额不足
60500服务错误
60600代理不支持续费
17003购买数量错误
17019代理售罄或库存不足
17012代理无库存
17001不支持购买
17002有效时长错误
17011代理已下架
17004代理过期或未分配
10086请求错误
8700下单失败（建议重试）
50000请求超频
17039代理禁止操作（过期续费）

3、账户信息 #

Path： /v1/account/info

Method： GET

接口描述：获取账户信息

返回数据：

{
    "data": {
        "code": 0,
        "msg": "Ok",
        "info": {
            "balance": "9752.42",
            "cashback": "0.00",
            "total_balance": "9752.42"
        }
    }
}

字段说明：

balance余额
cashback赠送金
total_balance账号总余额

4、地区查询 #

Path： /v1/area/list

Method： GET

接口描述：用于检查获取可购买的代理地区信息列表

返回数据：

{
    "data": {
        "code": 0,
        "msg": "Ok",
        "info": [
            {
                "id": "45",
                "ip_type": "STATIC_ISP",
                "status": "true",
                "ip_version": "IPv4",
                "country": "United States",
                "country_code": "US",
                "region": "Residential A"
            },
            {
                "id": "10",
                "ip_type": "STATIC_DATACENTER",
                "status": "true",
                "ip_version": "IPv4",
                "country": "United States",
                "country_code": "US",
                "region": "Zone A"
            },
            {
                "id": "34",
                "ip_type": "STATIC_ISP",
                "status": "true",
                "ip_version": "IPv4",
                "country": "South Korea",
                "country_code": "KR",
                "region": "Residential A"
            }
        ]
    }
}

字段说明：

id代理地区ID
ip_type代理类型：STATIC_DATACENTER 静态数据中心 STATIC_ISP 静态住宅
status状态：true 上架 false 售罄/下架
ip_versionIP版本：IPv4 IPv6
country国家：美国、英国
country_code国家编码：US
region可用区：A区(Zone A) B区(Zone B) 住宅 (Residential)

5、获取订单价格 #

Path： /v1/order/price

Method： GET

接口描述：用于获取购买/续费代理的订单价格

参数说明：

参数名是否必须示例备注使用场景
order_type是BUYEXTEND 续费 BUY 新购
days是30天数
area_id否239地区ID新购
proxy_ids否代理ID续费
num否1数量 <= 100新购

6、购买代理 #

Path： /v1/proxy/create

Method： POST

接口描述：购买代理

参数说明：

参数名是否必须示例备注使用场景
days是30天数（支持30、90、180、360）
area_id是239地区ID
auto_extend是1自动续费 0 关闭 1开启
num是1数量 <= 100

7、代理列表 #

Path： /v1/proxy/list

Method： GET

接口描述：查询已购买的代理

参数说明：

参数名是否必须示例备注使用场景
proxy_ids否86nz753w代理ID，多个使用英文逗号隔开
page是1页码
page_size是10每页条数 <= 50

返回数据：

{
    "data": {
        "code": 0,
        "msg": "Ok",
        "info": {
            "list": [
                {
                    "id": "86nz753w",
                    "host": "161.7.69.1",
                    "ip_type": "STATIC_DATACENTER",
                    "area_id": "10",
                    "public_ip": "161.7.69.1",
                    "port": "50101",
                    "type": "socks5",
                    "user": "xx",
                    "password": "xxx",
                    "auto_extend": "1",
                    "expire_time": "1776258092",
                    "buy_time": "1776257726",
                    "country_code": "US",
                    "ip_version": "IPv4"
                }
            ],
            "total": 1,
            "page": 1,
            "page_size": 50
        }
    }
}

字段说明：

id代理ID
host连接host
port端口
public_ip出口IP
type协议类型 socks5 ssh http
area_id地区ID
user账号
password密码
auto_extend是否开启自动续费：1是 0否
expire_time有效时间，时间戳；由于续费异步，完成续费后才能展示最新的有效时间
country_code国家编码：US
ip_versionIP版本：IPv4 IPv6
ip_type代理类型：STATIC_DATACENTER 静态数据中心 STATIC_ISP 静态住宅 STATIC_ISP_PRO 静态住宅pro
buy_time购买时间，时间戳

8、续费代理 #

Path： /v1/proxy/extend

Method： POST

接口描述：购买代理

参数说明：

参数名是否必须示例备注使用场景
days是30天数
proxy_ids是wjqprgq8代理ID，多个使用英文逗号隔开

提示：每次续费的代理数量不能超过300个

返回数据：

{
    "data": {
        "code": 0,
        "msg": "Ok",
        "info": {
            "order_id": "ed129d7e"
        }
    }
}

字段说明：

order_id订单ID

9、获取订单信息 #

Path： /v1/order/info

Method： GET

接口描述：查询已购买的代理

参数说明：

参数名是否必须示例备注使用场景
order_id是w9lx276w订单ID

返回数据：

{
    "data": {
        "code": 0,
        "msg": "Ok",
        "info": {
            "id": "w9lx276w",
            "deduct_total": "4.98",
            "proxy_ids": [
                "8z6olrve"
            ],
            "proxy_count": "1",
            "order_type": "BUY",
            "deduct_balance": "4.98",
            "deduct_cashback": "0"
        }
    }
}

字段说明：

id订单ID
deduct_total订单金额（实际扣除）
proxy_ids代理ID集合
proxy_count订单购买/续费代理数
order_type订单类型 BUY新购 EXTEND 续费

需要帮助？

如果您需要进一步说明或位置定位方面的帮助，请随时通过以下方式与我们联系：

  • 电子邮件：jenny@ipnut.com
  • 在线聊天：在我们的网站上提供24/7实时聊天。

静态住宅 静态数据中心

滚动至顶部