/api/meta/openapi
GETKhả dụng

Tài liệu OpenAPI

Mô tả OpenAPI 3.0 của API công khai, tạo từ danh mục và từ các bảng trường suy ra từ phản hồi thật.

GET/api/meta/openapi

Yêu cầu

Endpoint này không nhận tham số nào.

Yêu cầu mẫu

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

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ả
openapistring—Phiên bản đặc tả OpenAPI của tài liệu này.
infoobject—Tiêu đề, phiên bản và mô tả của API.
info.titlestring—Tiêu đề API.
info.versionstring—Phiên bản API.
info.descriptionstring—Mô tả ngắn về API và các quy ước của nó.
serversarray—Các URL gốc của API.
servers[]object—Một mục máy chủ.
servers[].urlstring—URL gốc cần ghép vào trước mọi đường dẫn.
tagsarray—Các danh mục endpoint.
tags[]object—Một danh mục.
tags[].namestring—Tên.
tags[].descriptionstring—Mô tả của danh mục.
pathsobject—Các endpoint, có khóa là đường dẫn. khóa động: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list
paths.{*}object—Các thao tác khả dụng trên một đường dẫn.
paths.{*}.getobject—Thao tác GET.
paths.{*}.get.operationIdstring—ID endpoint, cùng ID như trong danh mục.
paths.{*}.get.summarystring—Khối tóm tắt.
paths.{*}.get.descriptionstring—Những gì endpoint trả về, kèm ghi chú về độ phủ và giới hạn.
paths.{*}.get.tagsarray—Các danh mục của endpoint.
paths.{*}.get.tags[]string—ID danh mục.
paths.{*}.get.x-declared-statusstring—Mức khả dụng được khai báo: `available`, `partial` hoặc `unavailable`.
paths.{*}.get.x-cache-ttl-secondsnumbersThời gian sống của cache phía máy chủ của endpoint. có thể vắng mặt
paths.{*}.get.parametersarray—Các tham số yêu cầu. rỗng trong các mẫu dùng để tạo bảng này
paths.{*}.get.parameters[]object—Một tham số.
paths.{*}.get.parameters[].namestring—Tên.
paths.{*}.get.parameters[].instring—Nơi đặt tham số: `query` hoặc `path`.
paths.{*}.get.parameters[].requiredboolean—`true` khi tham số bắt buộc phải gửi.
paths.{*}.get.parameters[].descriptionstring—Ý nghĩa của tham số.
paths.{*}.get.parameters[].schemaobject—JSON Schema của giá trị tham số (type, default, enum, minimum, maximum).
paths.{*}.get.parameters[].examplestring—Giá trị ví dụ. có thể vắng mặt
paths.{*}.get.responsesobject—Các phản hồi có khóa là mã trạng thái HTTP; phản hồi 200 mang JSON Schema được tạo từ các phản hồi thực.
componentsobject—Các schema dùng chung, bao gồm body lỗi được mọi endpoint sử dụng.

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

Phản hồi mẫu

/api/meta/openapi · Phản hồi thật, ghi lại lúc 2026-11-13 03:53:45 UTC. Mảng và map dài được rút gọn khi hiển thị: tags có 21 phần tử; paths có 298 phần tử; paths.{*}.get.responses có 5 phần tử; paths.{*}.get.parameters có 3 phần tử; components.schemas.Error.properties.code.enum có 9 phần tử.

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

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ủ
5m
Micro-cache biên
10s
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:53:45 UTCHTTP 20040 msSchema khớp

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

100% trong 407 lần kiểm tra đạt

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/openapiKhả dụng
Tham số

Không có tham số.

URL yêu cầuhttps://www.coinboss.com/api/meta/openapi
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.