flow:read scope,每次成功调用 weight 为 1。REST 与 MCP 提供同一组 11 个能力。
端点
成交筛选
按标的查看
按合约查看
字段级参数、枚举和响应结构见顶部「API Reference」标签页。
示例
日期与代码
- 所有 Flow 日期参数都是 ET 交易日,只接受
YYYY-MM-DD,不接受 date-time。 - 建议统一使用带
O:前缀的完整 OCC 合约代码。flow.trades的contract_symbols筛选要求使用这种 canonical 形式;多个 ticker、合约、到期日、right、side 或 strategy 用逗号分隔。 SPX是产品级汇总 ticker,概览、bars 和 bucket 会覆盖月度与周度 root;需要精确区分SPX/SPXW时,使用支持root的合约目录、boards 或 chain 端点。
分页与完整性
flow.trades、flow.contract_options、flow.ticker_chain和flow.contract_bars的下一页游标位于_meta.next_cursor。flow.contract_bucket与flow.ticker_bucket的next_cursor/truncated位于data内,因为它们同时表达源窗口本身是否达到上限。- cursor 绑定 command、ticker/合约、查询参数、交易日和当前结果快照。跨查询复用,或翻页期间结果发生变化时,服务端返回
400 VALIDATION_ERROR;从第一页重新开始即可。 truncated=true表示源窗口已经达到自身上限。即使最后一页的next_cursor为null,也不能把该窗口解释为完整全集。
注意点
flow.contract_lookup查询完整 OCC 代码时,会返回当日已经出现 Flow 活动的合约,即使它暂时还没有出现在按到期日浏览的flow.contract_options中。精确 lookup 与合约目录服务不同场景,不应要求两者在盘中每一刻完全一致。- Flow 返回的是聚合后的成交与统计,不是逐笔原始成交。
print_count表示一个公开聚合包含的成交笔数。 - 金额字段使用
*_usd,比例字段使用 fractional*_pct(例如0.25表示 25%);缺失值为null,不会补成0。 - 读模型短暂不可用时返回
503 READ_MODEL_UNAVAILABLE。GET 请求可安全重试;具体策略见数据新鲜度。