24h成交量—未平倉—24h爆倉$1.36B24h多空比—BTC市佔—ETH市佔—
App
語言 ▾
NT$ TWD ▾
/api/meta/openapi
GET可用

OpenAPI 文件

公開 API 的 OpenAPI 3.0 描述，由端點目錄以及從真實回應推斷的欄位表產生。

GET/api/meta/openapi

請求

此端點不接受任何參數。

請求範例

curl -s "https://www.coinboss.com/api/meta/openapi"

回應欄位

欄位表由真實回應產生，因此列出的正是端點實際回傳的內容。路徑中的 a[] 代表陣列元素，{*} 代表以動態名稱（例如幣種或交易所）為鍵的物件。

欄位型別單位說明
openapistring—此文件的 OpenAPI 規格版本。
infoobject—API 的標題、版本與說明。
info.titlestring—API 標題。
info.versionstring—API 版本。
info.descriptionstring—API 及其慣例的簡短說明。
serversarray—API 的基礎 URL。
servers[]object—單一伺服器條目。
servers[].urlstring—要加在每個路徑前面的基礎 URL。
tagsarray—端點分類。
tags[]object—單一分類。
tags[].namestring—名稱。
tags[].descriptionstring—分類的說明。
pathsobject—端點，鍵為路徑。 動態鍵: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list
paths.{*}object—單一路徑上可用的操作。
paths.{*}.getobject—GET 操作。
paths.{*}.get.operationIdstring—端點 ID，與端點目錄中的 ID 相同。
paths.{*}.get.summarystring—摘要區塊。
paths.{*}.get.descriptionstring—端點回傳的內容，附覆蓋範圍與限制的說明。
paths.{*}.get.tagsarray—端點所屬的分類。
paths.{*}.get.tags[]string—分類 ID。
paths.{*}.get.x-declared-statusstring—宣告的可用性：`available`、`partial` 或 `unavailable`。
paths.{*}.get.x-cache-ttl-secondsnumbers端點的伺服器端快取存活時間。 可能不存在
paths.{*}.get.parametersarray—請求參數。 在產生此表所用的樣本中為空
paths.{*}.get.parameters[]object—單一參數。
paths.{*}.get.parameters[].namestring—名稱。
paths.{*}.get.parameters[].instring—參數的放置位置：`query` 或 `path`。
paths.{*}.get.parameters[].requiredboolean—參數必須傳送時為 `true`。
paths.{*}.get.parameters[].descriptionstring—參數的含義。
paths.{*}.get.parameters[].schemaobject—參數值的 JSON Schema（type、default、enum、minimum、maximum）。
paths.{*}.get.parameters[].examplestring—範例值。 可能不存在
paths.{*}.get.responsesobject—回應，鍵為 HTTP 狀態；200 回應帶有由實際回應產生的 JSON Schema。
componentsobject—共用的結構描述，包含所有端點使用的錯誤內容。

產生於 2026-11-11 23:03 UTC，依據 1 筆真實回應。

回應範例

/api/meta/openapi · 真實回應，擷取於 2026-11-13 03:53:45 UTC。 較長的陣列與對應表已截短顯示：tags 原有 21 個項目; paths 原有 298 個項目; paths.{*}.get.responses 原有 5 個項目; paths.{*}.get.parameters 原有 3 個項目; components.schemas.Error.properties.code.enum 原有 9 個項目。

  • {
    • "openapi": "3.0.3",
    • "info": {
      • "title": "CoinBoss API",
      • "version": "v1 (2026.11.12)",
      • "description": "Public market-data API of CoinBoss. Generated from the endpoint catalog and from field tables inferred from real responses."
      },
    • "servers": [
      • { … 1 }
      ],
    • "tags": [
      • { … 2 },
      • { … 2 }
      ],
    • "paths": {
      • "/api/coin-heatmap": { … 1 },
      • "/api/coins/all": { … 1 }
      },
    • "components": {
      • "schemas": { … 1 },
      • "securitySchemes": { … 1 }
      }
    }

詳細資訊

身分驗證
無。公開端點。
速率限制
每個 IP 每分鐘 1200 次請求
伺服器快取
5m
邊緣微快取
10s
時間戳記
Unix epoch 毫秒（UTC），除非欄位說明另有註明
回應格式
json
穩定性
穩定版
上線時間
2026-11-11

即時狀態

可用檢查於 2026-11-13 03:53:45 UTCHTTP 20040 ms結構描述相符

近 30 天可用率

407 次檢查中有 100% 通過

錯誤

所有端點的失敗回應都採用同一種結構。完整清單請見錯誤頁面。 錯誤與速率限制 →

錯誤碼HTTP意義處理方式
INVALID_PARAM400缺少必填參數，或某個值不被接受。已知時，`param` 會指出是哪個參數。請勿原樣重試；請修正請求。
UNAUTHORIZED401已送出 `CB-API-KEY` 標頭，但金鑰未知或已撤銷。公開資料不需要金鑰——請移除該標頭或改用有效的金鑰。請勿原樣重試。
FORBIDDEN403此路由不屬於公開 API（內部或僅限帳戶使用）。請勿重試。
NOT_FOUND404未知的路由，或所請求的幣種／交易所／基金不存在。請勿重試；請對照目錄檢查路徑與識別碼。
RATE_LIMITED429請求數超過每分鐘上限。`Retry-After` 會指出需等待的秒數。等待 `Retry-After` 指定的時間後，再以退避策略重試。
INTERNAL500非預期的伺服器錯誤。訊息刻意保持籠統；回報時請附上 `request_id`。幾秒後重試一次；若問題持續，請附上請求 ID 回報。
UPSTREAM_FAILED503此端點背後的資料來源未及時回應。不會以過期或替代的數字代替回傳。以退避策略重試；並查看狀態頁面。
UNAVAILABLE501 / 503資料集暫時尚未就緒（快取預熱中），或此端點目前尚無合法的公開來源。稍後重試；目錄會標示出設計上即無法使用的端點。
REQUEST_FAILED200部分舊版端點會以 HTTP 200 回應但帶有 `success: false`。請務必檢查 `success`，而不只是 HTTP 狀態碼。視訊息而定；請當作失敗的請求處理。

試用

GET/api/meta/openapi可用
參數

無參數。

請求 URLhttps://www.coinboss.com/api/meta/openapi
選擇一個端點並按下「送出請求」。回應內容、標頭與耗時會顯示在這裡。