SimilarwebAPI

SimilarwebAPI 在 /v1/similarweb 下提供 27 个只读数据接口，与其他 RequestBeam API 共用账户、API 密钥、余额和用量记录。实际可用性取决于已启用网关和 API 密钥权限；文档收录不代表生产环境已经开放。

鉴权

请传入 RequestBeam API 密钥，而不是第三方凭据：

Authorization: Bearer YOUR_API_KEY

请求示例

所有对外操作均使用 GET，参数放在 query 中，不传请求体。路径和参数名的大小写必须与文档完全一致。

curl --get "https://api.requestbeam.com/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

入站引荐接口使用单数 key，不接受 keys；结果行位于 Records，不是 Data。各操作的完整字段见接口参考。

数据范围

• 搜索：关键词建议、排名页面、网站关键词、自然与付费搜索、品牌词。
• 网站流量：互动指标、访问量、地域、设备、渠道和社交流量。
• 网站关系：外链、入站引荐、出站流量和相似网站。
• 历史：分别查询月度访问量、跳出率、访问时长和每次访问页数。

响应

成功响应保留原生 JSON，不新增 success/data 包装，保留字段名、未知字段、空数组和数字精度。不同接口可能使用 Data、Records 或其他结构，不能假设统一的结果行字段。

成功返回空结果不等于网站没有流量；请求失败也不能当作空数据处理。排查问题时请保留 X-Request-Id 和请求时间。

计费与分页

标准价格为每次成功请求 $0.0005，1000 次为 $0.50，全部 27 个接口统一计价。不按结果行数计费，成功返回空结果仍计一次；每次翻页都是独立请求。租户专属价格以账户有效价格为准。参数无效、未通过鉴权或余额不足的请求不会作为成功调用执行，上游请求失败不收费。

调用前账户余额须至少为 $0.10，这是平台最低调用余额要求；标准单次实际扣费仍为 $0.0005。

仅使用对应接口允许的分页字段。页码通常从 1 开始；外链接口使用 Page 和 PageSize，其他表格可能使用 page、pageSize 或 rowsPerPage。不要传入该接口不支持的分页大小字段。

错误

平台错误结构如下；code 是平台业务错误码，不是 HTTP 状态码：

{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

常见 HTTP 状态包括 400 参数无效、401 API 密钥无效、402 余额不足、403 无网关访问权限、429 限流及 5xx 上游或服务暂时失败。参数错误时应修正请求，不要原样重试。