Khối lượng 24h—Vị thế mở—Thanh lý 24h$1.36BLong/Short 24h—Thống trị BTC—Thống trị ETH—
Ứng dụng
Ngôn ngữ ▾
₫ VND ▾
/api/meta/endpoint
GETKhả dụngFRESH

Tài liệu endpoint

Tài liệu đầy đủ của một endpoint: tham số, bảng trường tạo từ phản hồi thật, một phản hồi mẫu đã ghi lại, các mẫu đã xác minh, lịch sử thăm dò 30 ngày, lỗi và giới hạn.

GET/api/meta/endpoint

Yêu cầu

Tham số truy vấn

TênKiểuBắt buộcMặc địnhGiá trị hợp lệMô tả
idstringBắt buộc——ID endpoint trong danh mục (ví dụ `sd-oi`). ID không xác định trả về 404. Ví dụ: sd-oi

Yêu cầu mẫu

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

Trường phản hồi

Bảng trường được tạo từ phản hồi thật nên liệt kê đúng những gì endpoint trả về. Đường dẫn dùng a[] cho phần tử mảng và {*} cho object có khóa là tên động, chẳng hạn một coin hoặc một sàn.

TrườngKiểuĐơn vịMô tả
successboolean—true khi yêu cầu thành công. Khi thất bại, nội dung phản hồi là `{ success: false, code, error, request_id }`.
schemastring—ID schema của phản hồi này (`coinboss.meta.endpoint/1`).
nownumbermsThời gian máy chủ lúc phản hồi được dựng.
endpointobject—Bản ghi của endpoint trong danh mục. Khóa của map là tên thuộc tính như `id`, `path`, `status`, `params`, `category`, `sources`, `units`, `formula`. khóa động: id,cat,kind,method,path,title
endpoint.{*}array|number|object|string|null—Giá trị của một thuộc tính: văn bản, một số, một danh sách (`params`, `required`, `ts_fields`) hoặc một object (`probe`, `category`, `example_query`); null khi chưa được đặt.
endpoint.{*}[]object|string—Phần tử của một thuộc tính dạng danh sách: một định nghĩa tham số trong `params`, hoặc một tên trong `required` / `ts_fields`. có thể vắng mặt
endpoint.{*}[].namestring—Tên. có thể vắng mặt
endpoint.{*}[].instring—Nơi gửi tham số: `query` hoặc `path`. có thể vắng mặt
endpoint.{*}[].typestring—Loại. có thể vắng mặt
endpoint.{*}[].requiredboolean—true khi tham số bắt buộc phải gửi. có thể vắng mặt
endpoint.{*}[].defaultnull—Giá trị được dùng khi tham số bị bỏ trống; null khi không có giá trị mặc định. có thể vắng mặt
endpoint.{*}[].enumnull—Danh sách các giá trị được chấp nhận; null khi tham số không bị giới hạn trong một danh sách. có thể vắng mặt
endpoint.{*}[].minnull—Tối thiểu. có thể vắng mặt
endpoint.{*}[].maxnull—Tối đa. có thể vắng mặt
endpoint.{*}[].examplestring—Giá trị ví dụ của tham số; null khi không có. có thể vắng mặt
endpoint.{*}[].descstring—Mô tả của tham số. có thể vắng mặt
endpoint.{*}.checked_atnumbermsDấu thời gian. có thể vắng mặt
endpoint.{*}.httpnumber—Mã trạng thái HTTP của yêu cầu thăm dò gần nhất. có thể vắng mặt
endpoint.{*}.okboolean—`true` khi yêu cầu thăm dò gần nhất trả về HTTP 200 với body JSON hợp lệ. có thể vắng mặt
endpoint.{*}.schema_okboolean—`true` khi phản hồi được thăm dò khớp với bảng trường trong tài liệu; `null` khi không có bảng trường. có thể vắng mặt
endpoint.{*}.latency_msnumbermsThời gian phản hồi của yêu cầu thăm dò gần nhất. có thể vắng mặt
endpoint.{*}.bytesnumberbytesKích thước body của phản hồi được thăm dò. có thể vắng mặt
endpoint.{*}.qualitynull—`meta.quality` do phản hồi được thăm dò báo cáo (FRESH / PARTIAL / STALE …); `null` khi endpoint không báo cáo giá trị này. có thể vắng mặt
endpoint.{*}.data_age_snumber|nullsSố giây kể từ sự kiện. có thể vắng mặt
endpoint.{*}.last_ok_atnumbermsDấu thời gian. có thể vắng mặt
endpoint.{*}.fail_streaknumbercountSố lượt thăm dò thất bại liên tiếp; 0 khi lượt thăm dò gần nhất thành công. có thể vắng mặt
endpoint.{*}.idstring—Định danh. có thể vắng mặt
endpoint.{*}.titlestring—Tiêu đề hiển thị của danh mục của endpoint (bên trong `category`). có thể vắng mặt
endpoint.{*}.coinstring—Ký hiệu coin, viết hoa (ví dụ BTC). có thể vắng mặt
fieldsarray—Bảng trường của phản hồi, suy ra từ các phản hồi thực; null khi chưa có bảng nào được tạo.
fields[]object—Một trường phản hồi: `path`, `type`, `unit`, `desc` và các cờ.
fields[].pathstring—Đường dẫn của trường trong phản hồi: `a.b` cho lồng nhau, `[]` cho phần tử mảng, `{*}` cho các giá trị của một map.
fields[].typestring—Loại.
fields[].unitstring|null—Đơn vị của các giá trị trong object này.
fields[].descstring—Mô tả của trường; null khi chưa có mô tả.
fields[].optionalboolean—Có mặt và là true khi trường bị thiếu trong ít nhất một phản hồi được lấy mẫu. có thể vắng mặt
fields[].mapboolean—Có mặt và là true khi object là một map có khóa phụ thuộc dữ liệu (coin, sàn, ngày) chứ không phải các trường cố định. có thể vắng mặt
fields[].keysarray—Mẫu các khóa đã thấy trong map; chỉ có ở các trường có `map` là true. có thể vắng mặt
fields[].keys[]string—Một khóa mẫu. có thể vắng mặt
fields_generated_atnumbermsDấu thời gian.
fields_generated_fromarray—Các URL yêu cầu có phản hồi thực được dùng để suy ra bảng trường; null khi không có bảng.
fields_generated_from[]string—Một đường dẫn yêu cầu được lấy mẫu, kèm chuỗi truy vấn.
exampleobject—Phản hồi thực thành công gần nhất do lượt thăm dò ghi lại: `request`, `captured_at`, `truncated` (độ dài gốc của các mảng bị rút ngắn) và `body`; null khi không có.
example.requeststring—Yêu cầu đã tạo ra ví dụ được ghi lại (đường dẫn và chuỗi truy vấn).
example.captured_atnumbermsDấu thời gian.
example.truncatedobject—Những gì đã bị rút ngắn trong ví dụ được ghi lại: với mỗi mảng hoặc map, số phần tử bị lược bỏ. Các khóa của nó phụ thuộc vào endpoint được mô tả.
example.bodyobject—Phản hồi được ghi lại của endpoint được mô tả, đã rút ngắn. Cấu trúc của nó chính là cấu trúc được mô tả bởi `fields`.
verified_samplesobject|null—Kết quả các yêu cầu mẫu bổ sung của lượt thăm dò (`at`, `samples` kèm truy vấn, mã trạng thái HTTP, độ trễ, kiểm tra schema); null khi không có yêu cầu nào được chạy.
verified_samples.atnumbermsThời điểm các mẫu bổ sung được kiểm tra lần gần nhất.
verified_samples.samplesarray—Số mẫu.
verified_samples.samples[]object—Số mẫu.
verified_samples.samples[].queryobject—Các tham số truy vấn của yêu cầu mẫu.
verified_samples.samples[].query.coinstring—Ký hiệu coin, viết hoa (ví dụ BTC). có thể vắng mặt
verified_samples.samples[].httpnumber—Mã trạng thái HTTP được trả về.
verified_samples.samples[].okboolean—`true` khi mẫu trả về đúng như mong đợi (HTTP 200 với JSON hợp lệ, hoặc mã trạng thái lỗi được mong đợi).
verified_samples.samples[].latency_msnumbermsThời gian phản hồi của yêu cầu mẫu.
verified_samples.samples[].schema_okboolean|null—`true` khi phản hồi mẫu khớp với bảng trường trong tài liệu; `null` khi không được kiểm tra.
verified_samples.samples[].qualitynull—`meta.quality` do phản hồi mẫu báo cáo; `null` khi không được báo cáo.
verified_samples.samples[].notestring|null—Ghi chú.
probe_detailnull—Các khác biệt schema do lượt thăm dò gần nhất phát hiện: các đường dẫn trường `missing`, `mismatched` và `undocumented`; null khi không có khác biệt nào.
uptime_30dobject—Các lượt kiểm tra thăm dò của endpoint này trong 30 ngày qua: các tổng, phần trăm thành công và phân tách theo ngày.
uptime_30d.checksnumbercountSố lượt kiểm tra thăm dò của endpoint trong 30 ngày qua (ít ngày hơn khi việc theo dõi bắt đầu muộn hơn).
uptime_30d.oknumbercountSố lượt kiểm tra thành công trong số đó.
uptime_30d.pctnumber%Phần trăm.
uptime_30d.daysarray—Giá trị theo ngày hoặc số ngày.
uptime_30d.days[]object—Giá trị theo ngày hoặc số ngày.
uptime_30d.days[].daystring—Ngày theo lịch (UTC).
uptime_30d.days[].checksnumbercountSố yêu cầu thăm dò trong ngày đó.
uptime_30d.days[].oknumbercountSố yêu cầu thăm dò thành công trong ngày đó.
uptime_30d.days[].pctnumber%Phần trăm.
uptime_30d.days[].avg_msnumbermsThời gian phản hồi trung bình trong ngày đó; `null` khi không có lượt kiểm tra nào.
uptime_30d.days[].max_msnumbermsPhản hồi chậm nhất trong ngày đó.
errorsarray—Các mã lỗi mà API có thể trả về, mỗi mã kèm mã trạng thái HTTP, ý nghĩa và lời khuyên về việc thử lại.
errors[]object—Một mã lỗi.
errors[].codestring—Mã.
errors[].httpnumber|string—Mã trạng thái HTTP gửi kèm mã lỗi này; là một chuỗi như `501 / 503` khi có nhiều hơn một mã áp dụng.
errors[].meaningstring—Ý nghĩa của lỗi.
errors[].retrystring—Lời khuyên về việc có nên thử lại hay không và thử lại như thế nào.
errors[].legacyboolean—Chỉ có và là true với mã lỗi được dùng bởi các endpoint cũ trả về HTTP 200 kèm `success: false`. có thể vắng mặt
rate_limitobject—Các quy tắc giới hạn tần suất của API công khai.
rate_limit.window_snumbersĐộ dài của khung đếm (60).
rate_limit.anonymous_per_minnumbercountSố yêu cầu mỗi phút được phép cho mỗi IP client khi không gửi API key.
rate_limit.scopestring—Văn bản nêu cách đếm yêu cầu: theo IP client khi ẩn danh, theo key khi có gửi header `CB-API-KEY`.
rate_limit.key_tiers_per_minobject—Số yêu cầu mỗi phút được phép cho từng bậc API key, có khóa là tên bậc.
rate_limit.key_tiers_per_min.hobbyistnumbercountSố yêu cầu mỗi phút cho các key thuộc bậc `hobbyist`.
rate_limit.key_tiers_per_min.startupnumbercountSố yêu cầu mỗi phút cho các key thuộc bậc `startup`.
rate_limit.key_tiers_per_min.standardnumbercountSố yêu cầu mỗi phút cho các key thuộc bậc `standard`.
rate_limit.key_tiers_per_min.professionalnumbercountSố yêu cầu mỗi phút cho các key thuộc bậc `professional`.
rate_limit.exemptarray—Các mẫu đường dẫn không bị tính vào giới hạn.
rate_limit.exempt[]string—Một mẫu đường dẫn được miễn, ví dụ `/api/coin-icon/*`.
rate_limit.headersarray—Tên các header phản hồi báo cáo trạng thái giới hạn tần suất.
rate_limit.headers[]string—Tên một header, ví dụ `X-RateLimit-Remaining`.
rate_limit.on_exceedobject—Nội dung được trả về khi vượt giới hạn: mã trạng thái `http` và `code` lỗi.
rate_limit.on_exceed.httpnumber—Mã trạng thái HTTP được trả về khi vượt giới hạn (429).
rate_limit.on_exceed.codestring—Mã.
relatedarray—Mọi endpoint thuộc cùng danh mục, kể cả endpoint này.
related[]object—Một endpoint: `id`, `path` và `title`.
related[].idstring—Định danh.
related[].pathstring—Đường dẫn yêu cầu của endpoint.
related[].titlestring—Tiêu đề hiển thị ngắn của endpoint.
probeobject—Tình trạng của lượt thăm dò endpoint đứng sau các trạng thái trực tiếp: thời điểm chạy gần nhất, tuổi của nó, chu kỳ và việc nó có còn mới hay không.
probe.last_run_atnumbermsDấu thời gian.
probe.age_snumbersSố giây kể từ lần cập nhật gần nhất của dòng này.
probe.interval_snumbersChu kỳ dự kiến giữa hai lượt thăm dò (300).
probe.freshboolean—true khi lượt thăm dò gần nhất chưa quá 20 phút; khi là false, trạng thái của các endpoint được báo là `unknown`.
probe.errornull—Thông báo lỗi (chỉ có khi thất bại).
metaobject—Phong bì của phản hồi này: ID schema, hệ thống tạo ra, các dấu thời gian, thời gian sống của cache và độ mới.
meta.schemastring—ID schema của phản hồi này; cùng giá trị với `schema` ở cấp cao nhất.
meta.sourcearray—Giá trị này đến từ đâu.
meta.source[]object—Giá trị này đến từ đâu.
meta.source[].systemstring—Hệ thống tạo ra dữ liệu; luôn là `coinboss` với các endpoint của trung tâm nhà phát triển.
meta.source[].componentstring—Thành phần đứng sau dữ liệu: lượt thăm dò endpoint và lượt tuần tra chất lượng dữ liệu.
meta.observed_atnull—Dấu thời gian.
meta.received_atnumbermsDấu thời gian.
meta.fetched_atnumbermsThời điểm CoinBoss lấy dữ liệu từ nguồn.
meta.windowstring—Khung thời gian.
meta.cache_ttl_snumbersThời gian sống của cache phía máy chủ cho phản hồi này.
meta.qualitystring—`FRESH` khi endpoint này được thăm dò trong vòng 20 phút qua, còn lại là `STALE`.
meta.is_staleboolean—true khi dòng cũ hơn khung dữ liệu mới; dòng quá hạn không được dùng trong các tổng.
meta.fallbackstring—Ghi chú dạng văn bản thuần về những gì endpoint này trả về khi dữ liệu đầu vào của nó quá hạn hoặc bị thiếu.

Tạo lúc 2026-11-11 23:03 UTC từ 3 phản hồi thật.

Phản hồi mẫu

/api/meta/endpoint?id=sd-oi · Phản hồi thật, ghi lại lúc 2026-11-13 03:59:28 UTC. Mảng và map dài được rút gọn khi hiển thị: errors có 9 phần tử; fields có 103 phần tử; related có 6 phần tử; endpoint có 35 phần tử; uptime_30d.days có 3 phần tử; verified_samples.samples có 4 phần tử.

  • {
    • "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"
      }
    }

Mẫu đã xác minh

Ngoài ví dụ ở trên, trình thăm dò còn gọi endpoint này với các tham số dưới đây và kiểm tra schema ở mỗi lần gọi.

Tham sốHTTPĐộ trễKết quả
id=sd-funding2003 msĐạt FRESH
id=liquidations-overview2002 msĐạt FRESH
—4001 msĐạt trả về lỗi như dự kiến

Kiểm tra lúc 2026-11-13 03:59:28 UTC

Chi tiết

Xác thực
Không cần. Endpoint công khai.
Giới hạn tần suất
1200 yêu cầu mỗi phút cho mỗi IP
Cache máy chủ
30s
Micro-cache biên
10s
Nguồn dữ liệu
Danh mục endpoint của CoinBoss, các schema do trình thăm dò API sinh ra, sd_api_probe.
Dấu thời gian
Unix epoch tính bằng mili giây (UTC), trừ khi mô tả trường ghi khác
Định dạng phản hồi
json
Độ ổn định
Ổn định
Có từ
2026-11-11

Trạng thái trực tiếp

Khả dụngKiểm tra lúc 2026-11-13 03:59:28 UTCHTTP 2002 msSchema khớpĐiểm dữ liệu mới nhất có tuổi 2m

Độ khả dụng, 30 ngày qua

99.75% trong 408 lần kiểm tra đạt

Lần thăm dò gần nhất phát hiện schema bị lệch
  • Được trả về nhưng chưa có trong tài liệu: probe_detail.missing, probe_detail.mismatched, probe_detail.undocumented, probe_detail.undocumented[]

Lỗi

Lệnh gọi thất bại có chung một cấu trúc trên mọi endpoint. Danh sách đầy đủ nằm ở trang lỗi. Lỗi và giới hạn tần suất →

MãHTTPÝ nghĩaCách xử lý
INVALID_PARAM400Thiếu một tham số bắt buộc hoặc một giá trị không được chấp nhận. `param` nêu tên tham số khi xác định được.Đừng thử lại với yêu cầu y nguyên; hãy sửa yêu cầu.
UNAUTHORIZED401Header `CB-API-KEY` đã được gửi nhưng khóa không tồn tại hoặc đã bị thu hồi. Dữ liệu công khai không cần khóa — hãy bỏ header hoặc dùng một khóa hợp lệ.Đừng thử lại với yêu cầu y nguyên.
FORBIDDEN403Route này không thuộc API công khai (nội bộ hoặc chỉ dành cho tài khoản).Đừng thử lại.
NOT_FOUND404Route không xác định, hoặc coin / sàn / quỹ được yêu cầu không tồn tại.Đừng thử lại; hãy đối chiếu đường dẫn và các mã định danh với danh mục.
RATE_LIMITED429Số yêu cầu vượt quá giới hạn mỗi phút. `Retry-After` cho biết số giây cần chờ.Chờ theo `Retry-After`, rồi thử lại có backoff.
INTERNAL500Lỗi máy chủ không mong đợi. Thông báo được cố ý viết chung chung; hãy trích dẫn `request_id` khi báo lỗi.Thử lại một lần sau vài giây; nếu lỗi vẫn tiếp diễn, hãy báo cáo kèm ID yêu cầu.
UPSTREAM_FAILED503Nguồn dữ liệu đứng sau endpoint này không trả lời kịp thời. Không có số liệu quá hạn hay số liệu thay thế nào được trả về thay cho nó.Thử lại có backoff; xem trang trạng thái.
UNAVAILABLE501 / 503Bộ dữ liệu tạm thời chưa sẵn sàng (cache đang được làm nóng) hoặc endpoint chưa có nguồn công khai hợp pháp.Thử lại sau; danh mục có đánh dấu những endpoint không khả dụng theo thiết kế.
REQUEST_FAILED200Một số endpoint cũ hơn trả về HTTP 200 với `success: false`. Hãy luôn kiểm tra `success`, không chỉ trạng thái HTTP.Tùy vào thông báo; hãy coi là một yêu cầu thất bại.

Dùng thử

GET/api/meta/endpointKhả dụng
Tham số

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

URL yêu cầuhttps://www.coinboss.com/api/meta/endpoint?id=sd-oi
Chọn một endpoint rồi nhấn “Gửi yêu cầu”. Phản hồi, header và thời gian xử lý sẽ hiện ở đây.