OpenAPI 接口文档
OpenAPI 接口文档
查询静态代理地区
查询当前可用的静态代理类型和地区。结果为平铺列表,不使用国家、省州、城市层级。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/regions |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
Query 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
static_type |
string | 否 | ISP(静态住宅代理)或 ISP_NATIVE(静态原生代理);省略时返回全部类型 |
地区名称根据 X-LANG 返回。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/static/regions?static_type=ISP' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--header 'X-LANG: zh_CN'
响应参数
data 为地区数组。
| 字段 | 类型 | 说明 |
|---|---|---|
static_type |
string | ISP 或 ISP_NATIVE |
region_code |
string | 静态代理地区编码 |
name |
string | 与 X-LANG 对应的地区名称 |
成功响应示例
{
"code": 0,
"msg": "success",
"data": [
{
"static_type": "ISP",
"region_code": "107",
"name": "United States"
}
],
"next": null
}
地区示例只说明格式。购买时必须使用接口实时返回的类型和地区编码。
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
静态类型或其他参数不符合要求 |
500000 |
系统处理失败,请求未完成 |