SEO API 文档

SEO API 只做一件事:给一个域名,返回它的注册信息和流量。本页介绍 REST 接口、每个响应字段、计费方式、给 AI Agent 用的 MCP 服务,以及命令行工具。

API

快速开始

  1. 使用 Google 登录 即可获得 10 免费积分。
  2. 在控制台创建一个 API key,数量不限。
  3. 在 Authorization 头里带上 key,调用下面的接口。
shell
curl "https://seo-api.org/api/v1/domain?domain=example.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

鉴权

每个请求都要以 Authorization: Bearer YOUR_API_KEY 的形式带上 key。无法设置 Authorization 头的客户端可以改用 x-api-key: YOUR_API_KEY。key 以 seo_ 开头。同一账号下的所有 key 共用积分余额;在控制台撤销 key 后立即失效。key 只能放在服务端或 Agent 配置里,不要写进浏览器代码。

状态与计费

只有 status 为 ready 时才扣 1 积分。24 小时内再次查询同一域名免费,不论用的是哪个 key、哪种方式。

  • pending: 我们之前没有这个域名的数据,已经排进采集队列。服务端最多等 15 秒再响应;请在 retryAfterSeconds 之后再查。免费。
  • empty: 域名已采集,但面板里没有它的流量,体量很小或刚上线的网站常见这种情况。注册信息照常返回。免费。
  • failed: 采集失败,原因见 message。免费。

错误码

错误使用标准 HTTP 状态码,外加一个稳定的错误码,可以据此分支处理。

402 Payment Required
{
  "ok": false,
  "error": {
    "code": "BILLING.INSUFFICIENT_CREDITS",
    "message": "Insufficient credits"
  }
}
  • SEO_API.MISSING_API_KEY

    HTTP401

    含义没有 Authorization 头,也没有 x-api-key 头。

  • SEO_API.INVALID_API_KEY

    HTTP401

    含义key 不存在或已被撤销。

  • SEO_API.INVALID_DOMAIN

    HTTP400

    含义缺少 domain 参数,或者它不是域名(IP 会被拒绝)。

  • BILLING.INSUFFICIENT_CREDITS

    HTTP402

    含义账号积分用完了。24 小时内的重复查询仍然可用。

  • SYSTEM.INTERNAL_SERVER_ERROR

    HTTP500

    含义我们这边出了问题,请退避后重试。