本页目录

开发者文档

Vaneform API

在自己的工具中读取流量估计、搜索数据和公开域名事实。HTTP 与 MCP 共用同一把 bearer 钥匙，准备创建时再登录。

获取接口钥匙 OpenAPI JSON

接口版本: v1.2.0
基础地址: /api/v1
鉴权: Bearer
返回格式: JSON

API 能读什么

和网页上同一套数据：先读一个域名的缓存快照；套餐允许时加上搜索足迹；也可以比较多个域名。

体量 · 全站访问估计
注册局 · 域名注册事实
画像 · 站点、DNS、托管和 TLS 事实
外链 · 公开链接图和榜单排名
足迹 · 本月 Pro 搜索可见性

发出第一个请求

这个例子读取一个域名的缓存快照，并返回当前可用数据。

01
获取钥匙
登录后打开 API 控制台，创建或查看 vf_live_ 钥匙。把它放在服务端或环境变量中。
02
调用端点
先从域名快照开始。它读取缓存，某一组没有数据时会写明。
03
读返回值
每个数字都保留 as_of、confidence 和 estimate。缺字段就是没有这个值。

curl -sS "https://vaneform.com/api/v1/domains/example.com?include=scale,registry" \
  -H "Authorization: Bearer $VANEFORM_API_KEY"

Authorization: Bearer $VANEFORM_API_KEY · 使用上面的请求头，并把钥匙放在 URL、日志和浏览器代码之外。

端点

GET/api/v1/domains/{domain}

域名快照

读取一个域名的缓存体量、注册局、站点画像和公开排名。

参数	说明
`domain`必填	域名，例如 google.com。
`include`可选	逗号分隔的数据组：scale、registry、profile、popularity，可选 search。默认: scale,registry,profile,popularity.

GET/api/v1/keyword

关键词简报

读取美国/英语搜索需求和 Google 结果。仅 Pro 可用；缓存未命中会使用搜索额度。

参数	说明
`q`必填	关键词，例如 ai 或 website traffic checker。

GET/api/v1/bulk

批量比较

并排比较多个域名，每个域名使用一次每日查站额度。

参数	说明
`q`必填	逗号分隔的域名，例如 google.com,apple.com。

GET/api/v1/tld

后缀比较

比较同一可注册名字的不同后缀，默认是 com、ai 和 io。

参数	说明
`q`必填	可注册基础名，例如 google。
`s`可选	可选的逗号分隔后缀。

GET/api/v1/account

账号额度

批量调用前读取套餐和剩余额度，不消耗查站次数。

按组读取`/api/v1/domains/{domain}/scale`、`/registry`、`/profile`、`/popularity` 和 `/search` 返回只含一组数据的 DomainResource。search 仅 Pro 可用。

返回什么

返回使用产品字段名，不带供应商名称。估计值保留日期和可信度；缺的数据组会写明状态。

JSON

{
  "domain": "example.com",
  "status": "ready",
  "refresh_policy": "cache_only",
  "scale": {
    "status": "ready",
    "estimate": "site",
    "visits": 7560000,
    "visits_mom_change_pct": 15.06,
    "as_of": "2026-08-31",
    "confidence": "medium"
  },
  "report_url": "https://vaneform.com/e/example-com"
}

readyready · 有可用数据

partialpartial · 只有部分数据或字段

missingmissing · 当前缓存没有快照

errorerror · 这一组读取失败

使用与额度

网站查站和 MCP 调用共用账号额度。批量调用前先查 `/api/v1/account`，并使用返回的 UTC 重置时间。

访客网站查站没有 API 钥匙；只能使用网站查询

登录 Free30 每日域名查站3 单次批量/后缀比较域名数0 每日 Pro 搜索足迹拉取

Pro300 每日域名查站30 单次批量/后缀比较域名数30 每日 Pro 搜索足迹拉取

未付费调用节奏未付费账号每 5 分钟 5 次；同时只处理 1 个请求同一账号 24 小时内重复读取同一域名不会再次计费。

错误码

所有错误都使用同一结构：code、message、status、request_id 和 docs_url。需要支持时，把 request_id 保留在日志中。

HTTP	code	说明
400	`invalid_request`	请求结构或参数无效。
400	`invalid_domain`	缺少域名，或它不是公开可注册域名。
401	`unauthorized`	缺少 Authorization bearer 钥匙，或格式不正确。
401	`invalid_api_key`	bearer 钥匙无效或已经轮换。
429	`lookup_limit_exceeded`	账号已经用完当天查站额度。
429	`lookup_rate_exceeded`	请求节奏或并发限制已触发。
403	`search_requires_pro`	search 需要 Pro 套餐。
403	`pro_required`	这个端点需要 Pro 套餐。
404	`not_found`	API 路径不存在。
405	`method_not_allowed`	这个 HTTP 方法不支持。
500	`internal_error`	服务端暂时无法完成请求。

收到 429 时等待 Retry-After，再继续请求；不要紧密循环重试。

收到 5xx 时使用有上限的指数退避，并保留 request_id。

连接 MCP 或使用 SKILL.md

MCP 提供同一套查站和对比能力。SKILL.md 说明每个工具何时用、字段怎么读。

MCP 连接

使用同一把 bearer 钥匙连接 Streamable HTTP 端点。选择客户端配置后，复制到 Cursor、Claude 或 Codex。

https://vaneform.com/mcp

{
  "mcpServers": {
    "vaneform": {
      "url": "https://vaneform.com/mcp",
      "headers": {
        "Authorization": "Bearer vf_live_…"
      }
    }
  }
}

SKILL.md

把公开的 Skill 文件下载到 Agent 环境。文件包含工具名、字段和额度，不包含钥匙。

打开 SKILL.md

HTTP 备用方式

MCP 不可用时，使用同一把钥匙直接调用 `/api/v1` 端点。

OpenAPI JSON