API 文档

认证方式

在请求头中携带 API 密钥，推荐使用 Bearer Token：

HTTP Header

Authorization: Bearer wb_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

也支持以下方式（不推荐在生产环境使用 Query 传参）：

X-API-Key: wb_live_xxx
?api_key=wb_live_xxx（仅 GET）

配额与限制

每个账户有每日 API 调用配额，在用户中心概览页可查看剩余量
配额按账户累计，同一账户下所有密钥共享配额
密钥可单独设置权限范围（scopes），仅能调用已授权的接口

错误码

HTTP	error	说明
401	unauthorized	缺少或无效的 API 密钥
403	forbidden	密钥无权访问该接口
429	quota_exceeded	今日配额已用尽
503	disabled	功能模块已关闭
404	not_found	未知 endpoint

WHOIS 查询

GET POST ?endpoint=whois

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=whois" \
  --data-urlencode "domain=example.com"

参数

参数	必填	说明
`domain`	是	要查询的域名
`lang`	否	界面语言，`en` 为英文时间格式

DNS 查询

GET POST ?endpoint=dns

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=dns" \
  --data-urlencode "domain=example.com"

备案查询

GET POST ?endpoint=icp

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=icp" \
  --data-urlencode "domain=example.com"

历史快照

GET POST ?endpoint=snapshot

对比域名首次 WHOIS 快照与当前结果。每个域名仅保留一条首次快照。前台 WHOIS 查询成功时会自动建档；本接口用于查看对比结果。

工作流程

WHOIS 查询成功时若尚无快照会自动建档。调用本接口时：若尚无快照则建档（is_new 为 true）；否则返回与当前 WHOIS 的对比结果。若未传 parsed_data，服务端会先执行 WHOIS 查询再对比。

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=snapshot" \
  --data-urlencode "domain=example.com"

参数

参数	必填	说明
`domain`	是	要检查的域名
`lang`	否	自动 WHOIS 时使用，`en` 为英文时间格式
`parsed_data`	否	POST JSON：已有 WHOIS 解析对象时可传入，跳过服务端 WHOIS 查询
`data_source`	否	POST JSON：与 `parsed_data` 配套的数据来源标识
`raw_data`	否	POST JSON：首次建档时的原始 WHOIS 文本（仅首次写入）

成功响应示例

首次查询（新建快照）：

JSON

{
  "success": true,
  "is_new": true,
  "is_changed": false,
  "has_snapshot": true,
  "changed_fields": [],
  "snapshot": {
    "parsed_data": { "created": "2000-01-01", "registrar": "Example Registrar" },
    "snapshot_at": "2026-07-06 12:00:00",
    "data_source": "rdap"
  }
}

再次查询且信息有变更：

JSON

{
  "success": true,
  "is_new": false,
  "is_changed": true,
  "has_snapshot": true,
  "changed_fields": ["updated", "nameservers"],
  "snapshot": {
    "parsed_data": { "created": "2000-01-01", "updated": "2020-01-01" },
    "snapshot_at": "2026-07-06 12:00:00",
    "data_source": "rdap"
  }
}

响应字段

字段	类型	说明
`is_new`	boolean	是否为该域名首次建档
`is_changed`	boolean	当前 WHOIS 是否与首次快照不一致
`changed_fields`	array	变更字段名列表（如 `registrar`、`nameservers`）
`snapshot.parsed_data`	object	首次快照中的 WHOIS 解析信息
`snapshot.snapshot_at`	string	快照记录时间
`snapshot.data_source`	string	快照创建时的数据来源

需要 MySQL 已连接且「历史快照」功能模块已开启。HTTP 状态码：成功为 200，业务失败为 422。

含义翻译

GET POST ?endpoint=translate

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=translate" \
  --data-urlencode "domain=example.com"

我的 IP

GET ?endpoint=myip

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=myip"

域名价格

GET ?endpoint=pricing

查询指定域名的注册与续费参考价格（OpenProvider）。接口会自动识别溢价域名：若该域名被注册局标记为溢价，响应中 premium 为 是，并返回对应的溢价注册/续费价格；普通域名则为 否。无需单独调用溢价查询接口。

溢价说明

溢价判定来自上游注册局/OpenProvider 的 is_premium 标记。同一接口同时覆盖普通域名与溢价域名查价；与「价格排行」不同，排行数据不含溢价域名。

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=pricing" \
  --data-urlencode "domain=example.com" \
  --data-urlencode "lang=zh"

参数

参数	必填	说明
`domain`	是	要查询的完整域名，如 `example.com`
`lang`	否	价格展示语言：`zh`（默认，人民币）或 `en`（美元）

成功响应示例

溢价域名示例（premium 为 是）：

JSON

{
  "success": true,
  "price_info": {
    "error": false,
    "premium": "是",
    "register_price": 1288,
    "renew_price": 1288,
    "register_usd": 0,
    "renew_usd": 0,
    "currency": "CNY",
    "cached": false
  }
}

普通域名示例（premium 为 否）：

JSON

{
  "success": true,
  "price_info": {
    "error": false,
    "premium": "否",
    "register_price": 68,
    "renew_price": 75,
    "register_usd": 0,
    "renew_usd": 0,
    "currency": "CNY",
    "cached": false
  }
}

`price_info` 字段

字段	类型	说明
`error`	boolean	是否查询失败；为 `true` 时见 `message`
`premium`	string	是否溢价域名：`是` 或 `否`
`register_price`	number	注册参考价（已按 `lang` 换算货币单位）
`renew_price`	number	续费参考价
`currency`	string	货币代码，如 `CNY`、`USD`
`register_usd`	number	美元注册价（`lang=en` 时与 `register_price` 一致，否则为 0）
`renew_usd`	number	美元续费价（同上）
`cached`	boolean	是否命中服务端价格缓存
`message`	string	失败原因（仅 `error` 为 `true` 时返回）

失败响应

JSON

{
  "success": false,
  "price_info": {
    "error": true,
    "message": "域名格式不正确"
  }
}

HTTP 状态码：成功为 200，业务失败（如域名不可用、上游错误）为 422。

价格排行

GET POST ?endpoint=price_ranking

按后缀（TLD）查询各注册商的注册/续费/转入价格排行，数据由合作方提供。不含溢价域名，仅作后缀级别的常规价格参考。

cURL

curl -G "{{BASE}}/api/v1/index" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "endpoint=price_ranking" \
  --data-urlencode "tld=com"

参数

参数	必填	说明
`tld`	是	后缀，如 `com`、`cn`

登录用户中心

创建账户

Whoisbox 用户 API

认证方式

配额与限制

错误码

WHOIS 查询

参数

DNS 查询

备案查询

历史快照

参数

成功响应示例

响应字段

含义翻译

我的 IP

域名价格

参数

成功响应示例

`price_info` 字段

失败响应

价格排行

参数

Whoisbox 用户 API

认证方式

配额与限制

错误码

WHOIS 查询

参数

DNS 查询

备案查询

历史快照

参数

成功响应示例

响应字段

含义翻译

我的 IP

域名价格

参数

成功响应示例

price_info 字段

失败响应

价格排行

参数

`price_info` 字段