24h成交量—未平仓—24h爆仓$1.36B24h多空比—BTC市占—ETH市占—
App
语言 ▾
¥ CNY ▾
/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 纪元毫秒（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
选择一个端点，然后点击“发送请求”。响应、响应头和耗时将显示在这里。