概览
Dealer Heatmap Data API 提供产品 Heatmap 数据的公共窄投影:保留采样时真实存在的到期日,并为每个到期日最多返回十个最强正值节点和十个最强负值节点。它不是完整行权价网格,也不能用于复刻产品内整张 Heatmap。
API Key 在账户页自助生成(见快速开始);鉴权方式为 Authorization: Bearer sk_live_...,配额包含于订阅。
采样与排名语义
API 每五分钟公开一个固定采样点。例如,09:30-09:35 ET 这一段固定读取 09:34 的分钟终值,并把 generated_at 或 minute_at 标记为该段起点 09:30。
- 这不是五分钟平均、合计或插值。
- 固定末分钟缺失时,该段直接缺失,不会回退到
09:33等更早分钟。 - 每个到期日独立排名:正值从大到小取前十,负值从小到大取前十;相同数值按行权价升序。
net_dealer_gex_usd = 0的节点不进入cells。
Snapshot
expirations列出该固定采样分钟真实存在的全部归档到期日。- 某个到期日即使全部节点为零,仍可出现在
expirations中,但不会产生cells。 cells只包含expiration、strike_usd和net_dealer_gex_usd。- API 不公开完整 strike 轴、逐节点 call/put 分解、跨到期行聚合、颜色比例尺或内部状态诊断。
- 不接受
format参数;未知参数会返回400 VALIDATION_ERROR。
History
History 一次查询一个到期日,返回该到期日在各固定采样点上的 signed Top 节点。
旧的
strike 参数和 /cell-history 路径已不再属于公共 Data API 契约。
- 窗口固定为最近三个 NYSE 交易时段的 RTH;周末、节假日、夏令时与半日市按 NYSE 日历处理。
from按采样段起点包含,to按采样段起点不包含。早于最老可用交易时段返回404 RANGE_TOO_DEEP。- 只有该到期日在固定末分钟真实存在时,该段才参与分页;到期日存在但所有值为零时返回空
cells。 - 归档为空洞时不生成占位行,不插值、不补零,也不回退到更早分钟。空结果是
200加空数组。
新鲜度与调用频率
内容时间以generated_at、minute_at 和 _meta.data_freshness_seconds 为准。由于公共投影每五分钟才形成一个新采样点,通常没有必要以秒级频率轮询;在需要最新点时,每个采样段完成后请求一次即可。
当前应有的 snapshot 采样点暂缺时返回 503 READ_MODEL_UNAVAILABLE。Heatmap 能力未开放或处于维护 / 恢复窗口时返回 503 SERVICE_DISABLED。两者的重试方式不同,见错误处理与数据新鲜度。