DATASET · flow

美股未按时交割量

flow.fail_to_deliver

资金流与做空

这是资金、持仓、借券与交易流中的“美股未按时交割量”数据集；一行由 instrument_id、settlement_date、source 定位，主要字段包括 cusip、symbol、market、ftd_quantity、price。

下载本类 JSON 下载完整 JSON.gz 先获取 Key

字段25

关键字段3

更新口径producer_schedule

时间列settlement_date

单页上限5000

分页Cursor

PIT不支持

规模1M-9M

WHAT IT ANSWERS

这张表适合回答什么

观察资金、持仓、借券或做空变化
构建拥挤度和资金方向指标

GRAIN & TIME

一行代表什么

业务粒度: 每行代表“美股未按时交割量”的一条记录；逻辑粒度由 instrument_id × settlement_date × source 共同确定。
时间口径: 以 settlement_date 为主要查询时间轴；除下方限制特别说明外，时间戳按 UTC、日期按来源市场日历解释。
更新节奏: 由对应生产任务或事件触发更新，不承诺固定日历频率；查询前先检查最新时间。

KEY FIELDS

先看这些字段

instrument_id: WarrenHub 统一证券标识；跨证券数据集优先用它联接。
settlement_date: settlement date 对应的日历日期。
source: 标准化数据来源；同一业务键可能因来源不同而有多行。

RECOMMENDED JOINS

怎样和其他表关联

ref.instrumenton instrument_id

用 instrument_id 补充证券代码、名称、市场、交易所和资产类型。

HOW TO QUERY SAFELY

查询方法与已知限制

先用 catalog 确认当前契约；可按 catalog 中列出的 filters 进一步缩小范围；单页最多 5000 行，响应有 has_more 时原样传回 next_cursor 继续分页。

返回范围仍受 Friends 权限、单页上限和 catalog 中的筛选契约约束。

MACHINE CONTRACT

筛选、排序与分页

UNVERSIONED

默认排序: instrument_id, settlement_date, source
唯一键: instrument_id, settlement_date, source
读取模式: canonical_final_active
最大时间窗: 未单独限制

可用 filters

instrument_id→ instrument_id · integer

market→ market · string

provider→ provider · string

source→ source · string

symbol→ symbol · string

POINT IN TIME

可复现读取

NOT AVAILABLE

该资产没有 PIT 契约。普通 rows 端点仍按当前公开读模式返回数据；不要把它表述成历史时点快照。

COPY-READY CALLS

怎么调用

同一数据集可用 HTTP、Python SDK、CLI 或 MCP；Key 始终只通过环境变量/Bearer Header 传递。

READ ONLY

HTTP

curl --fail-with-body -H "Authorization: Bearer $FRIENDS_DATA_API_KEY" "https://api.alphahubs.uk/api/v1/data/datasets/flow/fail_to_deliver/rows?limit=100&instrument_id=1"

PYTHON SDK

from friends_data_api import FriendsDataClient, Settings

async with FriendsDataClient(Settings.from_env()) as client:
    page = await client.get_dataset_rows('flow', 'fail_to_deliver', limit=100, filters={'instrument_id': 1})
    print(page.data)
    if page.has_more:
        print("next cursor:", page.next_cursor)

CLI

friends-data get-dataset-rows flow fail_to_deliver --limit 100 --filter instrument_id=1

MCP TOOL CALL

{
  "arguments": {
    "dataset": "fail_to_deliver",
    "filters": {
      "instrument_id": 1
    },
    "limit": 100,
    "namespace": "flow"
  },
  "tool": "get_dataset_rows"
}

FIELD DICTIONARY

25 个返回字段

descriptionSource 可在 JSON 中区分仓库注释、标准术语表和名称推导说明。

筛选字段

#	字段	ClickHouse 类型	JSON	可空	角色	说明
1	`instrument_id`	`UInt64`	`integer`	no	filter, default_order, warehouse_primary_key, contract_unique_key	WarrenHub canonical instrument identifier; use it for cross-dataset joins.标准术语表
2	`cusip`	`String`	`string`	no	value	Source-normalized field: cusip.名称推导
3	`symbol`	`String`	`string`	no	filter	Display or trading symbol for the instrument.标准术语表
4	`market`	`LowCardinality(String)`	`string`	no	filter	Canonical market or country-market code.标准术语表
5	`settlement_date`date	`Date`	`string / date`	no	time, default_order, warehouse_primary_key, contract_unique_key	Calendar date for settlement date (YYYY-MM-DD).名称推导
6	`ftd_quantity`	`UInt64`	`integer`	no	value	Source-normalized field: ftd quantity.名称推导
7	`price`	`Nullable(Float64)`	`number`	yes	value	Source-normalized field: price.名称推导
8	`description`	`String`	`string`	no	value	Human-readable description supplied or normalized from the source.标准术语表
9	`half_month_period`	`LowCardinality(String)`	`string`	no	value	Source-normalized field: half month period.名称推导
10	`publish_ts`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	provenance	UTC point-in-time availability timestamp used by PIT reads.标准术语表
11	`source_ts`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	provenance	Timestamp asserted by the upstream source.标准术语表
12	`ingested_at`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	provenance	UTC timestamp when the source record entered the warehouse.标准术语表
13	`source`	`LowCardinality(String)`	`string`	no	filter, default_order, warehouse_primary_key, contract_unique_key, provenance	Normalized upstream source identifier.标准术语表
14	`provider`	`LowCardinality(String)`	`string`	no	filter, provenance	Upstream data provider identifier.标准术语表
15	`source_url`	`String`	`string`	no	provenance	URL of the upstream evidence or record when distributable.标准术语表
16	`source_record_id`	`String`	`string`	no	provenance	Provider-side identifier for the source record.标准术语表
17	`raw_payload_hash`	`String`	`string`	no	provenance	Opaque fingerprint of the normalized source payload for provenance checks.标准术语表
18	`parser_version`	`LowCardinality(String)`	`string`	no	provenance	Version of the parser or normalizer that produced the row.标准术语表
19	`quality_status`	`LowCardinality(String)`	`string`	no	provenance	Machine-readable data-quality classification.标准术语表
20	`license_scope`	`LowCardinality(String)`	`string`	no	provenance	License or redistribution scope attached to the row.标准术语表
21	`visibility_tier`	`LowCardinality(String)`	`string`	no	provenance	Serving visibility tier attached to the row.标准术语表
22	`ingest_run_id`	`String`	`string`	no	provenance	Identifier of the ingestion run that produced the row.标准术语表
23	`version`	`UInt64`	`integer`	no	provenance	Monotonic row version used for correction-aware reads.标准术语表
24	`version_ts`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	provenance	UTC timestamp associated with the row version.标准术语表
25	`is_deleted`	`UInt8`	`integer`	no	value	Soft-delete marker; public serving excludes current tombstones.标准术语表

字典口径

结构来自 Friends 只读身份可见的真实 serving relation；权限、过滤、排序、PIT 与分页来自可执行 DatasetSpec。Schema observed at 2026-10-06T18:08:52Z。