REST API

系统与元数据

四个不提供任何市场指标的接口:它们告诉你服务是否响应、数据是否新鲜、有哪些资产,以及每个资产实际能提供什么。

#服务健康状态

GET/v1/health无需密钥

探测接口。它说明服务是否运行、数据库是否响应。这是唯一无需密钥即可访问的接口,并且从不计入配额,因此监控系统可以随意查询而不消耗任何额度。

200
{
  "status": "ok",
  "timestamp": 1775647758094,
  "database": "connected"
}

出现问题时,响应为 503 并带有 "database": "unreachable"。

#数据源新鲜度

GET/v1/status

针对为市场核心供数的每个数据源:行数、最后一次写入、距今时长,以及服务器端按该数据源自身阈值计算的 is_stale 标志。在构建分析之前应先查询此接口:提前知道数据陈旧,好过在结果中才发现。

200
{
  "status": "ok",
  "timestamp": 1775648290510,
  "tables": {
    "raw_exchange.klines_1m": {
      "count": 4881977,
      "last_insert": "2026-08-29T11:37:00+00:00",
      "age_seconds": 70.5,
      "is_stale": false,
      "stale_threshold_seconds": 180
    },
    "raw_exchange.trades_raw": {
      "count": 918964,
      "last_insert": "2026-08-29T11:38:09+00:00",
      "age_seconds": 1.5,
      "is_stale": false,
      "stale_threshold_seconds": 30,
      "per_exchange": {
        "venue_a": { "age_seconds": 1.2, "is_stale": false },
        "venue_b": { "age_seconds": 2.0, "is_stale": false }
      },
      "any_exchange_stale": false
    }
  }
}
字段类型说明
countinteger可用行数。
last_insertstring | null最后一次写入的 ISO 8601 时间戳。
age_secondsfloat | null自那以来经过的秒数。
is_staleboolean距今时长超过阈值时为真。设有阈值的空数据源会被标记为陈旧:“完全没有数据”比“数据延迟”是更强的信号。
stale_threshold_secondsinteger | null所采用的阈值。null 表示该数据源不适合设置阈值(例如每天只发布一次的指数)。
per_exchangeobject对于多交易所数据源:每个交易所各自的距今时长。某个交易所中断时可在此看到。
any_exchange_staleboolean与 per_exchange 配合使用。根级标志基于最新鲜的数据源:只要其他交易所仍在写入,某个已停止的交易所在根级是看不出来的。这个标志会把它显示出来。

#交易对目录

GET/v1/symbolsdata_type · symbols

已启用资产的实时列表。以它为准:不要在客户端硬编码列表,应在启动时读取。

200
{
  "status": "ok",
  "timestamp": 1775648758094,
  "data_type": "symbols",
  "data": [
    { "symbol": "BTCUSDT", "base_asset": "BTC", "name": "Bitcoin" },
    { "symbol": "ETHUSDT", "base_asset": "ETH", "name": "Ethereum" }
  ]
}
字段类型说明
symbolstring传入 ?symbol= 的标识符。
base_assetstring基础资产(BTC、ETH)。期权接口的 ?asset= 使用的就是它。
namestring完整名称,用于显示。

#能力报告

GET/v1/symbols/{symbol}/capabilitiesdata_type · symbol_capabilities

该资产实际能提供的内容,基于最近二十四小时测量。它让你能预判空响应而不是事后发现,并区分在此无意义的指标与暂时受阻的指标。

curl -H "X-API-KEY: $BYTNODE_KEY" \
  "https://api.bytnode.com/v1/symbols/USDCUSDT/capabilities"
字段类型说明
symbolstring所查询的资产。
asset_classstringcrypto 或 stablecoin。
feeds_active_last_24hobject八个数据流,根据其在窗口内是否产生数据分别为真或假。能力不等于新鲜度:二十小时前还活跃的数据流在这里仍为真。
computed_metrics_availablearray可计算的指标:其所有输入数据流都存在。
computed_metrics_blockedobject无法计算的指标,附缺失的数据流及原因。
computed_metrics_not_applicableobject对于稳定币:所有源自期货市场的指标及其原因。这是有意为之,而非故障。
stablecoin_notestring对于稳定币:现货上仍可用的内容。

未知或已停用的交易对会返回 400,并附有效交易对列表。