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.
/api/meta/openapiYê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ường | Kiểu | Đơn vị | Mô tả |
|---|---|---|---|
| openapi | string | — | Phiên bản đặc tả OpenAPI của tài liệu này. |
| info | object | — | Tiêu đề, phiên bản và mô tả của API. |
| info.title | string | — | Tiêu đề API. |
| info.version | string | — | Phiên bản API. |
| info.description | string | — | Mô tả ngắn về API và các quy ước của nó. |
| servers | array | — | Các URL gốc của API. |
| servers[] | object | — | Một mục máy chủ. |
| servers[].url | string | — | URL gốc cần ghép vào trước mọi đường dẫn. |
| tags | array | — | Các danh mục endpoint. |
| tags[] | object | — | Một danh mục. |
| tags[].name | string | — | Tên. |
| tags[].description | string | — | Mô tả của danh mục. |
| paths | object | — | 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.{*}.get | object | — | Thao tác GET. |
| paths.{*}.get.operationId | string | — | ID endpoint, cùng ID như trong danh mục. |
| paths.{*}.get.summary | string | — | Khối tóm tắt. |
| paths.{*}.get.description | string | — | Những gì endpoint trả về, kèm ghi chú về độ phủ và giới hạn. |
| paths.{*}.get.tags | array | — | Các danh mục của endpoint. |
| paths.{*}.get.tags[] | string | — | ID danh mục. |
| paths.{*}.get.x-declared-status | string | — | Mức khả dụng được khai báo: `available`, `partial` hoặc `unavailable`. |
| paths.{*}.get.x-cache-ttl-seconds | number | s | Thời gian sống của cache phía máy chủ của endpoint. có thể vắng mặt |
| paths.{*}.get.parameters | array | — | 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[].name | string | — | Tên. |
| paths.{*}.get.parameters[].in | string | — | Nơi đặt tham số: `query` hoặc `path`. |
| paths.{*}.get.parameters[].required | boolean | — | `true` khi tham số bắt buộc phải gửi. |
| paths.{*}.get.parameters[].description | string | — | Ý nghĩa của tham số. |
| paths.{*}.get.parameters[].schema | object | — | JSON Schema của giá trị tham số (type, default, enum, minimum, maximum). |
| paths.{*}.get.parameters[].example | string | — | Giá trị ví dụ. có thể vắng mặt |
| paths.{*}.get.responses | object | — | 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. |
| components | object | — | 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"
- "tags"
- "paths"
- "/api/coin-heatmap"
- "/api/coins/all"
- "components"
- "schemas"
- "securitySchemes"
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ụ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ĩa | Cách xử lý |
|---|---|---|---|
| INVALID_PARAM | 400 | Thiế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. |
| UNAUTHORIZED | 401 | Header `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. |
| FORBIDDEN | 403 | Route 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_FOUND | 404 | Route 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_LIMITED | 429 | Số 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. |
| INTERNAL | 500 | Lỗ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_FAILED | 503 | Nguồ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. |
| UNAVAILABLE | 501 / 503 | Bộ 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_FAILED | 200 | Mộ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ử
/api/meta/openapiKhả dụngKhông có tham số.
https://www.coinboss.com/api/meta/openapiEndpoint khác trong danh mục này
- Ma trận chất lượng dữ liệu (góc nhìn trình thu thập) /api/sd/quality
- Danh mục API /api/meta/catalog
- Nhật ký thay đổi và chính sách phiên bản /api/meta/changelog
- Tài liệu endpoint /api/meta/endpoint
- Tài liệu OpenAPI /api/meta/openapi
- Ma trận chất lượng dữ liệu /api/meta/quality
- Trạng thái dịch vụ /api/meta/status
- Kiểm tra một ký hiệu coin có được nền tảng nhận biết hay không /api/coin-exists
- Bảng ánh xạ từ ký hiệu coin sang đường dẫn icon lưu cục bộ /api/coin-icons
- Tóm tắt tổng hợp của trang coin /api/content/coin
- Tóm tắt các chuyên mục toàn trang /api/content/summary
- Bảng tỷ giá tiền pháp định /api/currency/fx
- Bảng ánh xạ từ id sàn sang đường dẫn icon lưu cục bộ /api/exchange-icons
- Kiểm tra liveness /api/health
- Thống kê trang nghiên cứu /api/research/stats