REST API

概览

一次请求，一个已聚合好的响应。所有接口共享相同的结构、相同的响应包装和相同的通用参数：适用于一个数据族的规则，同样适用于其他数据族。

#请求的结构

结构

GET https://api.bytnode.com/v1/<family>/<metric>
  ?symbol=BTCUSDT       # required on per-asset routes
  &timeframe=1h         # on bucketed routes
  &limit=100            # on /history routes
  &fields=timestamp,rate

X-API-KEY: your_key

路径表明数据族和指标。参数表明资产、周期和深度。请求头携带密钥。调用任何接口只需要知道这些。

只有一个端点不遵循这种结构：POST /v1/indicators，它接收 JSON 正文，因为它描述的是一次计算，而不是一次读取。

#最新值还是历史

大多数指标有两个版本。不带后缀的接口返回最新值：一个对象，或 null。/history 后缀返回一个列表，按时间从新到旧排列。

curl

# The latest value
GET /v1/basis?symbol=BTCUSDT

# The last 200, from newest to oldest
GET /v1/basis/history?symbol=BTCUSDT&limit=200

# A dated window, in milliseconds
GET /v1/basis/history?symbol=BTCUSDT&since_ms=1756425600000&until_ms=1756512000000

#通用参数

参数	类型	默认值	说明
`symbol`	string	必填	资产，使用目录格式（BTCUSDT）。缺失：422。未知：400，并附列表。全市场接口不接受此参数。
`timeframe`	string	必填	用于按区间的接口：1m、5m、15m、30m、1h、4h、1d。不在列表中：422。
`limit`	integer	100	用于 /history 接口。一般上限为 1000，多空比和交易所间价差为 500。
`since_ms / until_ms`	integer	—	以 Unix 毫秒表示的时间窗口，仅限支持该参数的接口。过滤先于 limit 生效。
`live`	boolean	false	用于按区间的最新值接口：返回进行中的周期，标记为 is_closed: false。
`fields`	string	—	data 的 CSV 投影，嵌套字段用点号表示。未知字段：422，并给出建议。

不存在的东西

任何接口都没有 exchange 参数：响应是聚合的，不标明交易所，唯一的例外是交易所间价差。传入该参数会返回 422。

#数据族

认证一把 API 密钥用于三个通道。放在哪里、如何保护、如何轮换。响应与错误通用响应结构、?fields= 投影、错误码及其含义。使用限制速率、同时连接数、历史深度，以及遇到 429 时该怎么做。约定交易对、周期、多交易所聚合、已收盘 K 线与数据源覆盖。REST APIREST 请求的结构、可用的数据族，以及 latest / history 的选择。系统与元数据健康状态、数据源新鲜度、交易对目录与能力报告。快照一次请求获取六十一个字段，并附带 unavailable 与 coverage 键。价格与成交量K 线、聚合成交、逐笔数据、大额订单与涨跌幅。衍生品资金费率、持仓量、爆仓、多空比、基差与交易所间价差。资金流与微观结构CVD、聚合订单簿、VWAP、买卖比、平均规模与热力图。技术指标按需计算的二十种指标，已与 TradingView 校准。期权BTC 与 ETH 的持仓量、成交量、看跌/看涨比、最大痛点、隐含波动率与希腊值。链上与网络比特币网络、BTC 链上估值，以及以太坊的八个数据族。宏观、ETF 与情绪官方宏观序列、日内宏观 K 线、ETF 基本面、代币经济与恐惧贪婪指数。WebSocket 数据流四个合并频道、按消息认证、序列号与关闭码。

所有接口都汇集在一页的端点目录中。