身份验证

身份验证

CoinBoss API 是公开的。调用任何数据端点都不需要账户或 API 密钥。

无需密钥

使用普通的 HTTPS GET 即可调用目录中的任何端点。匿名请求按 IP 地址限流:每分钟 1200 次请求。

curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"

可选的 API 密钥

如果你的多个服务共用一个 IP 地址,或者你所在网络的出口地址会变化,可以在账户中创建密钥,并通过 CB-API-KEY 请求头发送。携带有效密钥的请求按密钥计数,而不是按 IP 地址计数。

  • 密钥在账户的 API 密钥页面创建和吊销。需要已验证的邮箱地址。
  • 完整密钥仅在创建时显示一次。系统只存储其哈希值,因此无法再次显示。
  • 每个账户最多可持有五个有效密钥。
  • 未知或已吊销的密钥会被忽略:该请求按匿名请求处理,并计入 IP 地址的额度。

管理 API 密钥

携带密钥的请求

curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
  -H "CB-API-KEY: $COINBOSS_API_KEY"

速率限制档位

所有档位返回的数据相同。在当前免费期内,匿名流量和所有密钥均按最高档位提供服务。

档位每分钟请求数
hobbyist30
startup80
standard300
professional1200当前对所有人生效

保护密钥安全

  • 请像对待密码一样对待密钥。将其保存在环境变量或密钥管理服务中,不要写进源代码。
  • 不要把密钥嵌入网页、浏览器扩展或移动应用。任何下发到客户端的内容都可能被用户读取。请从你的服务器调用 API,或在浏览器中匿名调用。
  • 一旦怀疑密钥泄露,请立即吊销并创建新密钥。
  • CoinBoss 绝不会索要交易所的 API 密钥。数据采集自交易所的公开端点,本 API 既不需要也不接受任何交易所凭证。

从浏览器调用

响应包含 Access-Control-Allow-Origin: *,因此可以从任意网页源调用数据端点。X-Request-Id、X-Cache 和 X-RateLimit-* 响应头对脚本可见。

账户端点

/api/user 和 /api/auth 下的端点属于网站的登录后功能(自选列表、偏好设置、密钥管理)。它们使用网站会话,不属于公开数据 API,也不在目录中列出。