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

端點文件

單一端點的完整文件：參數、由真實回應產生的欄位表、擷取到的回應範例、已驗證的樣本、30 天探測歷史、錯誤與限制。

GET/api/meta/endpoint

請求

查詢參數

名稱型別必填預設值可用值說明
idstring必填——目錄中的端點 ID（例如 `sd-oi`）。未知的 ID 回傳 404。 範例: sd-oi

請求範例

curl -s "https://www.coinboss.com/api/meta/endpoint?id=sd-oi"

回應欄位

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

欄位型別單位說明
successboolean—請求成功時為 true。失敗時回應內容為 `{ success: false, code, error, request_id }`。
schemastring—此回應的結構描述 ID（`coinboss.meta.endpoint/1`）。
nownumberms建立回應時的伺服器時間。
endpointobject—端點的目錄紀錄。對應表的鍵為屬性名稱，例如 `id`、`path`、`status`、`params`、`category`、`sources`、`units`、`formula`。 動態鍵: id,cat,kind,method,path,title
endpoint.{*}array|number|object|string|null—單一屬性的值：文字、數字、清單（`params`、`required`、`ts_fields`）或物件（`probe`、`category`、`example_query`）；未設定時為 null。
endpoint.{*}[]object|string—清單屬性的元素：`params` 中為參數定義，`required` / `ts_fields` 中為名稱。 可能不存在
endpoint.{*}[].namestring—名稱。 可能不存在
endpoint.{*}[].instring—參數的傳送位置：`query` 或 `path`。 可能不存在
endpoint.{*}[].typestring—類型。 可能不存在
endpoint.{*}[].requiredboolean—參數必須傳送時為 true。 可能不存在
endpoint.{*}[].defaultnull—省略參數時採用的值；沒有預設值時為 null。 可能不存在
endpoint.{*}[].enumnull—可接受值的清單；參數不限於特定清單時為 null。 可能不存在
endpoint.{*}[].minnull—最小值。 可能不存在
endpoint.{*}[].maxnull—最大值。 可能不存在
endpoint.{*}[].examplestring—參數的範例值；未提供時為 null。 可能不存在
endpoint.{*}[].descstring—參數的說明。 可能不存在
endpoint.{*}.checked_atnumberms時間戳記。 可能不存在
endpoint.{*}.httpnumber—最近一次探測請求的 HTTP 狀態。 可能不存在
endpoint.{*}.okboolean—最近一次探測請求回傳 HTTP 200 且 JSON 內容有效時為 `true`。 可能不存在
endpoint.{*}.schema_okboolean—探測到的回應與文件記載的欄位表相符時為 `true`；沒有欄位表時為 `null`。 可能不存在
endpoint.{*}.latency_msnumberms最近一次探測請求的回應時間。 可能不存在
endpoint.{*}.bytesnumberbytes探測到的回應內容大小。 可能不存在
endpoint.{*}.qualitynull—探測到的回應所回報的 `meta.quality`（FRESH / PARTIAL / STALE …）；端點未回報時為 `null`。 可能不存在
endpoint.{*}.data_age_snumber|nulls距該事件的秒數。 可能不存在
endpoint.{*}.last_ok_atnumberms時間戳記。 可能不存在
endpoint.{*}.fail_streaknumbercount連續失敗的探測次數；最近一次探測成功時為 0。 可能不存在
endpoint.{*}.idstring—識別碼。 可能不存在
endpoint.{*}.titlestring—端點所屬分類的顯示標題（位於 `category` 內）。 可能不存在
endpoint.{*}.coinstring—幣種代號，大寫（例如 BTC）。 可能不存在
fieldsarray—回應的欄位表，由實際回應推斷而得；尚未產生欄位表時為 null。
fields[]object—單一回應欄位：`path`、`type`、`unit`、`desc` 與旗標。
fields[].pathstring—欄位在回應中的路徑：`a.b` 表示巢狀結構，`[]` 表示陣列項目，`{*}` 表示對應表的值。
fields[].typestring—類型。
fields[].unitstring|null—此物件中數值的單位。
fields[].descstring—欄位的說明；尚未撰寫時為 null。
fields[].optionalboolean—該欄位在至少一個抽樣回應中缺失時出現，且值為 true。 可能不存在
fields[].mapboolean—該物件是鍵隨資料而定（幣種、交易所、日期）的對應表、而非固定欄位時出現，且值為 true。 可能不存在
fields[].keysarray—對應表中觀測到的鍵樣本；僅出現在 `map` 為 true 的欄位上。 可能不存在
fields[].keys[]string—單一樣本鍵。 可能不存在
fields_generated_atnumberms時間戳記。
fields_generated_fromarray—用來推斷欄位表之實際回應所對應的請求 URL；沒有欄位表時為 null。
fields_generated_from[]string—單一抽樣請求路徑，含查詢字串。
exampleobject—探針擷取到的最近一次成功實際回應：`request`、`captured_at`、`truncated`（被截短陣列的原始長度）與 `body`；沒有時為 null。
example.requeststring—產生該擷取範例的請求（路徑與查詢字串）。
example.captured_atnumberms時間戳記。
example.truncatedobject—擷取範例中被截短的內容：每個陣列或對應表被略去的項目數。其鍵取決於所記載的端點。
example.bodyobject—所記載端點的擷取回應，已截短。其結構即 `fields` 所描述的結構。
verified_samplesobject|null—探針額外抽樣請求的結果（`at`，以及含查詢、HTTP 狀態、延遲、結構描述檢查的 `samples`）；未執行時為 null。
verified_samples.atnumberms最近一次檢查額外抽樣的時間。
verified_samples.samplesarray—樣本數。
verified_samples.samples[]object—樣本數。
verified_samples.samples[].queryobject—抽樣請求的查詢參數。
verified_samples.samples[].query.coinstring—幣種代號，大寫（例如 BTC）。 可能不存在
verified_samples.samples[].httpnumber—回傳的 HTTP 狀態。
verified_samples.samples[].okboolean—抽樣請求回傳符合預期的結果（HTTP 200 且 JSON 有效，或預期的錯誤狀態）時為 `true`。
verified_samples.samples[].latency_msnumberms抽樣請求的回應時間。
verified_samples.samples[].schema_okboolean|null—抽樣回應與文件記載的欄位表相符時為 `true`；未檢查時為 `null`。
verified_samples.samples[].qualitynull—抽樣回應所回報的 `meta.quality`；未回報時為 `null`。
verified_samples.samples[].notestring|null—備註。
probe_detailnull—最近一次探測發現的結構描述差異：`missing`、`mismatched` 與 `undocumented` 欄位路徑；沒有差異時為 null。
uptime_30dobject—此端點過去 30 天的探針檢查：總數、成功百分比與逐日明細。
uptime_30d.checksnumbercount過去 30 天內對該端點的探針檢查次數（開始追蹤的時間較晚時，天數會較少）。
uptime_30d.oknumbercount其中成功的檢查次數。
uptime_30d.pctnumber%百分比。
uptime_30d.daysarray—每日數值或天數。
uptime_30d.days[]object—每日數值或天數。
uptime_30d.days[].daystring—日曆日（UTC）。
uptime_30d.days[].checksnumbercount當日的探測請求次數。
uptime_30d.days[].oknumbercount當日成功的探測請求次數。
uptime_30d.days[].pctnumber%百分比。
uptime_30d.days[].avg_msnumberms當日的平均回應時間；沒有檢查時為 `null`。
uptime_30d.days[].max_msnumberms當日最慢的回應。
errorsarray—API 可能回傳的錯誤碼，各附 HTTP 狀態、含義與重試建議。
errors[]object—單一錯誤碼。
errors[].codestring—代碼。
errors[].httpnumber|string—隨此錯誤碼送出的 HTTP 狀態；適用多個狀態時為字串，例如 `501 / 503`。
errors[].meaningstring—該錯誤的含義。
errors[].retrystring—是否重試以及如何重試的建議。
errors[].legacyboolean—僅在該錯誤碼用於以 HTTP 200 搭配 `success: false` 回應的舊端點時出現，且值為 true。 可能不存在
rate_limitobject—公開 API 的速率限制規則。
rate_limit.window_snumbers計數時間視窗的長度（60）。
rate_limit.anonymous_per_minnumbercount未傳送 API 金鑰時，每個用戶端 IP 每分鐘允許的請求數。
rate_limit.scopestring—說明請求計數方式的文字：匿名時依用戶端 IP 計數，傳送 `CB-API-KEY` 標頭時依金鑰計數。
rate_limit.key_tiers_per_minobject—各 API 金鑰等級每分鐘允許的請求數，鍵為等級名稱。
rate_limit.key_tiers_per_min.hobbyistnumbercount`hobbyist` 等級金鑰的每分鐘請求數。
rate_limit.key_tiers_per_min.startupnumbercount`startup` 等級金鑰的每分鐘請求數。
rate_limit.key_tiers_per_min.standardnumbercount`standard` 等級金鑰的每分鐘請求數。
rate_limit.key_tiers_per_min.professionalnumbercount`professional` 等級金鑰的每分鐘請求數。
rate_limit.exemptarray—不計入限制的路徑樣式。
rate_limit.exempt[]string—單一豁免路徑樣式，例如 `/api/coin-icon/*`。
rate_limit.headersarray—回報速率限制狀態的回應標頭名稱。
rate_limit.headers[]string—單一標頭名稱，例如 `X-RateLimit-Remaining`。
rate_limit.on_exceedobject—超過限制時回傳的內容：`http` 狀態與錯誤 `code`。
rate_limit.on_exceed.httpnumber—超過限制時回傳的 HTTP 狀態（429）。
rate_limit.on_exceed.codestring—代碼。
relatedarray—同一分類的所有端點，包含此端點。
related[]object—單一端點：`id`、`path` 與 `title`。
related[].idstring—識別碼。
related[].pathstring—端點的請求路徑。
related[].titlestring—端點的簡短顯示標題。
probeobject—即時狀態背後的端點探針狀態：上次執行時間、距今時間、間隔，以及是否新鮮。
probe.last_run_atnumberms時間戳記。
probe.age_snumbers此資料列距上次更新的秒數。
probe.interval_snumbers兩次探測之間的預定間隔（300）。
probe.freshboolean—最近一次探測距今不到 20 分鐘時為 true；為 false 時端點狀態會回報為 `unknown`。
probe.errornull—錯誤訊息（僅在失敗時出現）。
metaobject—此回應的封套資訊：結構描述 ID、產生資料的系統、時間戳記、快取存活時間與新鮮度。
meta.schemastring—此回應的結構描述 ID；與頂層 `schema` 的值相同。
meta.sourcearray—數值的來源。
meta.source[]object—數值的來源。
meta.source[].systemstring—產生資料的系統；開發者中心的端點一律為 `coinboss`。
meta.source[].componentstring—資料背後的元件：端點探針與資料品質巡檢。
meta.observed_atnull—時間戳記。
meta.received_atnumberms時間戳記。
meta.fetched_atnumbermsCoinBoss 從來源擷取資料的時間。
meta.windowstring—時間視窗。
meta.cache_ttl_snumbers此回應的伺服器端快取存活時間。
meta.qualitystring—此端點在過去 20 分鐘內被探測過時為 `FRESH`，否則為 `STALE`。
meta.is_staleboolean—資料列超出新鮮視窗時為 true；過期的資料列不計入總額。
meta.fallbackstring—輸入資料過期或缺失時此端點回傳內容的純文字說明。

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

回應範例

/api/meta/endpoint?id=sd-oi · 真實回應，擷取於 2026-11-13 03:59:28 UTC。 較長的陣列與對應表已截短顯示：errors 原有 9 個項目; fields 原有 103 個項目; related 原有 6 個項目; endpoint 原有 35 個項目; uptime_30d.days 原有 3 個項目; verified_samples.samples 原有 4 個項目。

  • {
    • "success": true,
    • "schema": "coinboss.meta.endpoint/1",
    • "now": 1794542368241,
    • "endpoint": {
      • "id": "sd-oi",
      • "cat": "open-interest"
      },
    • "fields": [
      • { … 4 },
      • { … 4 }
      ],
    • "fields_generated_at": 1794438008862,
    • "fields_generated_from": [
      • "/api/sd/oi?coin=BTC",
      • "/api/sd/oi?coin=ETH",
      • "/api/sd/oi?coin=SOL",
      • "/api/sd/oi?coin=ARKM"
      ],
    • "example": {
      • "request": "/api/sd/oi?coin=BTC",
      • "captured_at": 1794542259642,
      • "truncated": { … 4 },
      • "body": { … 17 }
      },
    • "verified_samples": {
      • "at": 1794542259642,
      • "samples": [ … 2 ]
      },
    • "probe_detail": {
      • "missing": [],
      • "mismatched": [],
      • "undocumented": [ … 6 ]
      },
    • "uptime_30d": {
      • "checks": 411,
      • "ok": 411,
      • "pct": 100,
      • "days": [ … 2 ]
      },
    • "errors": [
      • { … 4 },
      • { … 4 }
      ],
    • "rate_limit": {
      • "window_s": 60,
      • "anonymous_per_min": 1200,
      • "scope": "per client IP for anonymous requests; per key when a CB-API-KEY header is sent",
      • "key_tiers_per_min": { … 4 },
      • "exempt": [ … 1 ],
      • "headers": [ … 4 ],
      • "on_exceed": { … 2 }
      },
    • "related": [
      • { … 3 },
      • { … 3 }
      ],
    • "probe": {
      • "last_run_at": 1794542029183,
      • "age_s": 339,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "meta": {
      • "schema": "coinboss.meta.endpoint/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794542259642,
      • "fetched_at": 1794542368241,
      • "window": "latest",
      • "cache_ttl_s": 30,
      • "quality": "FRESH",
      • "is_stale": false,
      • "fallback": "field table comes from the last schema generation; example is the last successful real response"
      }
    }

已驗證的樣本

除了上方的範例之外，探針還會以下列參數呼叫此端點，並在每次呼叫時檢查結構描述。

參數HTTP延遲結果
id=sd-funding2002 ms通過 FRESH
id=liquidations-overview2002 ms通過 FRESH
—4002 ms通過 回傳預期的錯誤

檢查於 2026-11-13 03:29:26 UTC

詳細資訊

身分驗證
無。公開端點。
速率限制
每個 IP 每分鐘 1200 次請求
伺服器快取
30s
邊緣微快取
10s
資料來源
CoinBoss 端點目錄、由 API 探測產生的結構描述、sd_api_probe。
時間戳記
Unix epoch 毫秒（UTC），除非欄位說明另有註明
回應格式
json
穩定性
穩定版
上線時間
2026-11-11

即時狀態

可用檢查於 2026-11-13 03:53:45 UTCHTTP 2004 ms結構描述相符最新資料點距今 71s

近 30 天可用率

408 次檢查中有 99.75% 通過

最近一次探測發現結構描述偏移
  • 回應中有但文件未記載: probe_detail.missing, probe_detail.mismatched, probe_detail.undocumented, probe_detail.undocumented[]

錯誤

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

錯誤碼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/endpoint可用
參數

string — Endpoint id from the catalog (for example `sd-oi`). Unknown ids return 404.

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