ProxyByte 开放API

通过API接口程序化管理您的代理IP资源

快速开始

6个步骤即可完成API接入，开始程序化管理代理IP

创建 API Token

在控制台创建 API Token

添加服务器白名单

将服务器IP加入白名单

查询库存

查看目标区域可用库存

批量购买代理IP

下单购买所需数量

轮询订单状态

等待 status 变为 completed

接入业务

使用 VLESS/SOCKS5/HTTP

认证方式

所有API接口均需要 Token 认证访问

API 基础地址：https://api.proxybyte.com

http

GET /api/open/getAccountBalance HTTP/1.1
Host: api.proxybyte.com
Authorization: Bearer your_api_token
Content-Type: application/json

json

// 通用响应格式
{
  "code": 200,    // 状态码，200 表示请求成功
  "msg": "SUCCESS",  // 状态信息
  "data": { ... }    // 业务数据
}

// 错误码
// 200 - 请求成功（具体业务是否成功需看 data.isSuccess）
// 401 - Token 无效或已过期
// 403 - 服务器IP不在白名单中
// 500 - 服务器内部错误，请稍后重试

国家和地区代码

购买代理IP时使用以下区域代码指定目标国家

国家/地区	代码
中国大陆	CN
中国香港	HK
新加坡	SG
日本	JP
马来西亚	MY
越南	VN
印度尼西亚	ID
澳大利亚	AU
美国	US
墨西哥	MX
巴西	BR
阿根廷	AR
英国	UK
德国	DE
法国	FR
意大利	IT
西班牙	ES
荷兰	NL
挪威	NO
罗马尼亚	RO
乌克兰	UA
土耳其	TU

API 接口文档

完整的接口说明、参数定义及响应示例

基础接口

异步购买(推荐)

续费接口

推荐使用异步购买接口，相比同步接口具有更高的稳定性和成功率。IP 分配通常 1 分钟内完成。购买后需轮询订单状态直到 status 变为 completed。

POST/api/open/async/final/stock

获取可用区域及其库存状态，返回的区域 id 用于后续购买接口。

请求参数

参数名	必填	类型	说明
`proxyAsnType`	否	string	IP类型，目前仅支持 isp

请求示例

bash

curl -X POST 'https://api.proxybyte.com/api/open/async/final/stock' \
  -H 'Authorization: Bearer your_token' \
  -H 'Content-Type: application/json' \
  -d '{"proxyAsnType": "isp"}'

响应示例

json

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 12,
      "area": "US",
      "areaCn": "美国",
      "region": "us-ny",
      "regionCn": "纽约",
      "status": "1"
    },
    {
      "id": 15,
      "area": "JP",
      "areaCn": "日本",
      "region": "jp-tk",
      "regionCn": "东京",
      "status": "1"
    }
  ]
}

POST/api/open/async/final/batchBuyProxyIP

提交购买请求，系统后台异步分配IP。返回订单号后，通过查询订单接口获取最终结果。

请求参数

参数名	必填	类型	说明
`areaId`	是	int	区域ID（来自库存接口返回的 id 字段）。测试请传 51025
`batchSize`	是	int	购买数量
`months`	是	int	购买时长（月），1个月=30天
`autoRenewal`	否	boolean	是否自动续费（默认 false）

请求示例

bash

curl -X POST 'https://api.proxybyte.com/api/open/async/final/batchBuyProxyIP' \
  -H 'Authorization: Bearer your_token' \
  -H 'Content-Type: application/json' \
  -d '{
    "areaId": 12,
    "batchSize": 3,
    "months": 1,
    "autoRenewal": false
  }'

响应示例

json

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "msg": "SUCCESS",
    "orderNo": "2025632256314",
    "isSuccess": true
  }
}

每个IP默认5Mbps带宽，同时支持 VLESS + SOCKS5 + HTTP 三种协议，购买后返回全部协议连接信息。

GET/api/open/async/final/orderInfo?orderNo={orderNo}

根据订单号查询购买结果。购买提交后需轮询此接口，直到 status 变为 completed。

请求参数

参数名	必填	类型	说明
`orderNo`	是	string	购买时返回的订单号

请求示例

bash

curl 'https://api.proxybyte.com/api/open/async/final/orderInfo?orderNo=2025632256314' \
  -H 'Authorization: Bearer your_token'

响应示例

json

// 处理中
{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "msg": "IP分配中",
    "isSuccess": true,
    "status": "process"
  }
}

// 已完成
{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "msg": "购买成功",
    "isSuccess": true,
    "totalPrice": 150.00,
    "ipNumbers": 3,
    "ipList": [
      {
        "id": 37700,
        "realIP": "192.158.1.1",
        "area": "US",
        "regionName": "New York",
        "ip": "gw1.proxybyte.com",
        "port": 10901,
        "authUser": "pb_user_37700",
        "authPassword": "m1n2o3p4",
        "vlessLink": "vless://uuid@gw1.proxybyte.com:443?..."
      }
    ],
    "status": "completed"
  }
}

建议轮询间隔：5秒。建议最大轮询时间：3分钟。若超过3分钟仍为 process 状态，请联系技术支持。

SDK 代码示例

快速集成，提供 Python 和 Node.js 完整示例

Python

Node.js

python

import requests
import time

API_BASE = "https://api.proxybyte.com"
TOKEN = "your_api_token"

headers = {
    "Authorization": f"Bearer {TOKEN}",
    "Content-Type": "application/json"
}

# 1. 获取库存
resp = requests.post(f"{API_BASE}/api/open/async/final/stock",
    headers=headers,
    json={"proxyAsnType": "isp"}
)
stock = resp.json()["data"]
print(f"可用区域: {len(stock)} 个")

# 2. 购买IP
resp = requests.post(f"{API_BASE}/api/open/async/final/batchBuyProxyIP",
    headers=headers,
    json={"areaId": 12, "batchSize": 1, "months": 1}
)
order_no = resp.json()["data"]["orderNo"]
print(f"订单号: {order_no}")

# 3. 轮询订单状态
while True:
    resp = requests.get(f"{API_BASE}/api/open/async/final/orderInfo",
        headers=headers,
        params={"orderNo": order_no}
    )
    data = resp.json()["data"]
    if data["status"] == "completed":
        print(f"购买成功，共 {data['ipNumbers']} 个IP")
        for ip in data["ipList"]:
            print(f"  VLESS: {ip['vlessLink']}")
        break
    time.sleep(5)

常见问题

关于API使用的常见疑问解答

Q: VLESS 协议和 SOCKS5 该如何选择?

A: 如果您使用指纹浏览器（AdsPower、Multilogin 等），选择 SOCKS5 或 HTTP 协议；如果您通过 v2rayN / Xray / Clash 等客户端使用，推荐选择 VLESS 协议，流量特征更隐蔽。

Q: 购买后多久可以使用?

A: 使用异步购买接口后，通常 1 分钟内 IP 分配完成。轮询订单状态为 completed 后即可使用。

Q: IP 到期和失效有什么区别?

A: expireDate 是到期时间，到期后 IP 停止服务但仍可续费延长；invalidDate 是失效时间，失效后 IP 不可使用且不可续费，需要重新购买。

Q: 白名单添加后多久生效?

A: 添加后立即生效。

Q: 自定义域名有什么好处?

A: 使用自有域名作为代理连接地址，便于统一管理，且域名不会与其他用户共享，降低被批量封禁的风险。