Developer API

公开 API 文档

为外部网站提供统一的币种详情、行情榜单、最新排名和图表数据接口。所有数据来自本地数据库，当前覆盖前 100 个币种。

API Base URLhttp://localhost:3106

正式部署后，将 localhost 替换为你的实际域名。接口统一使用 /api/v1 前缀。

开始接入

认证方式

每个外部网站使用独立客户端 Key，便于撤销、轮换和限流。

快速开始

使用 curl 验证你的客户端 Key 是否可用。

创建客户端

进入后台管理，填写网站名称、来源域名和访问频率。

保存 Key

只保存客户端 Key 的完整值，不要放入前端公开代码仓库。

发起请求

在服务端请求接口，并将 Key 放在 Header 中。

第一条请求

curl "http://localhost:3106/api/v1/market/summary" \
  -H "X-Local-API-Key: YOUR_CLIENT_API_KEY"

Endpoints

接口目录

选择接口查看参数、curl 请求和响应示例。

接口目录5 endpoints

GET/api/v1/market/summary

市场总览

返回全球指标、情绪、指数、前 100 汇总和数据质量状态。

缓存默认 30 秒

请求参数

此接口没有查询参数。

请求示例

curl "http://localhost:3106/api/v1/market/summary" \
  -H "X-Local-API-Key: YOUR_CLIENT_API_KEY"

响应示例

{
  "data": {
    "global": { "totalMarketCap": 0, "totalVolume24h": 0 },
    "top100": { "count": 100, "totalMarketCap": 0 },
    "dataQuality": { "status": "fresh" }
  },
  "meta": { "apiVersion": "v1", "clientId": "mk_demo" }
}

统一响应结构

成功响应都包装在 data 字段中，便于不同网站复用。

{
  "data": { "...": "业务数据" },
  "meta": {
    "apiVersion": "v1",
    "generatedAt": "2026-07-12T00:00:00.000Z",
    "clientId": "mk_xxxxx",
    "cache": { "maxAge": 30, "staleSeconds": 180 }
  }
}

错误码与使用限制

错误响应同样包含 meta 字段。

401invalid_api_key

客户端 Key 缺失、错误或已撤销。

403origin_not_allowed

请求来源不在允许名单内。

429rate_limited

超过客户端每分钟访问频率。

503api_not_configured

服务端尚未配置认证或来源白名单。

行情数据按 15 分钟采集；接口缓存策略可以在后台管理页调整。图表 K 线是本地快照生成数据，并非 CoinMarketCap 官方 OHLCV。