跳到正文

ko.io API 参考

每个接口的参数、访问权限、响应格式和可直接运行的请求。在免费版接口后加 ?demo=true,无需密钥即可调用。第一次使用?先看 REST 快速开始。

下方的交互式参考为英文界面,接口路径、参数和字段名与代码中一致。

OpenAPI 3.1 规范: /openapi.yaml

中文要点

  • 基础 URL:https://api.ko.io,数据接口路径以 /api/v1/ 开头。
  • 身份验证:在 Authorization 请求头中以 Bearer 令牌发送 API 密钥(以 ko_live_ 开头),在控制台 → API 密钥中创建。
  • 演示模式:在免费版接口后加 ?demo=true,无需密钥即可调用,按 IP 限制调用频率;Pro 版和团队版接口会返回 403 PLAN_REQUIRED。
  • 响应格式:成功时返回 { data, meta },失败时返回 { error: { code, message } }。分页使用 page 和 per_page。
  • 额度:按账户计算,每日在 00:00 UTC 重置,响应头含 X-RateLimit-Remaining。免费版仅含最近一个季度和最新数据。各套餐额度与错误码说明见文档页。