身分驗證

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"

速率限制級別

所有級別回傳的資料都相同。在目前的免費期間，匿名流量與所有金鑰皆適用最高級別。

妥善保管金鑰

• 請把金鑰當成密碼看待。將它存放在環境變數或機密管理服務中，不要寫進原始碼。
• 不要把金鑰嵌入網頁、瀏覽器擴充功能或行動應用程式。任何交付到用戶端的內容都可能被使用者讀取。請從你的伺服器呼叫 API，或從瀏覽器以匿名方式呼叫。
• 一旦懷疑金鑰外洩，請立即撤銷並建立新的金鑰。
• CoinBoss 絕不會索取交易所的 API 金鑰。資料採集自交易所的公開端點，本 API 不需要、也不接受任何交易所憑證。

從瀏覽器呼叫

回應包含 Access-Control-Allow-Origin: *，因此任何網頁來源都能呼叫資料端點。X-Request-Id、X-Cache 與 X-RateLimit-* 標頭已開放給指令碼讀取。

帳戶端點

/api/user 與 /api/auth 底下的端點屬於網站的登入後功能（自選清單、偏好設定、金鑰管理）。這些端點使用網站的工作階段，不屬於公開資料 API，也不列在目錄中。