DATASET · ref

规范证券主表

ref.instrument

A 股标的与映射

Friends Data API 的统一标的入口，定义 instrument_id、代码、名称、市场、交易所和资产类型。

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

字段30

关键字段1

更新口径daily

时间列—

单页上限50000

分页Cursor

PIT不支持

规模100K-999K

WHAT IT ANSWERS

这张表适合回答什么

用名称或代码解析 instrument_id
联接跨数据集证券记录
构建可查询标的宇宙

GRAIN & TIME

一行代表什么

业务粒度: 每行代表“规范证券主表”的一条记录；逻辑粒度由 instrument_id 共同确定。
时间口径: 该表没有单一主时间列；请使用业务日期或版本字段，并按关键字段确定范围。
更新节奏: 通常按交易日或自然日更新；具体最新日期请以返回数据为准。

KEY FIELDS

先看这些字段

instrument_id: WarrenHub 统一证券标识；跨证券数据集优先用它联接。

RECOMMENDED JOINS

怎样和其他表关联

这是证券维表：market、fundamental、flow、ownership 等表只要含 instrument_id，就优先用该字段关联到这里补代码、名称、市场、交易所和资产类型。

HOW TO QUERY SAFELY

查询方法与已知限制

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

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

MACHINE CONTRACT

筛选、排序与分页

UNVERSIONED

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

可用 filters

asset_type→ asset_type · string

exchange→ exchange · string

market→ market · 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/ref/instrument/rows?limit=100&asset_type=equity"

PYTHON SDK

from friends_data_api import FriendsDataClient, Settings

async with FriendsDataClient(Settings.from_env()) as client:
    page = await client.get_dataset_rows('ref', 'instrument', limit=100, filters={'asset_type': 'equity'})
    print(page.data)
    if page.has_more:
        print("next cursor:", page.next_cursor)

CLI

friends-data get-dataset-rows ref instrument --limit 100 --filter asset_type=equity

MCP TOOL CALL

{
  "arguments": {
    "dataset": "instrument",
    "filters": {
      "asset_type": "equity"
    },
    "limit": 100,
    "namespace": "ref"
  },
  "tool": "get_dataset_rows"
}

FIELD DICTIONARY

30 个返回字段

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

筛选字段

#	字段	ClickHouse 类型	JSON	可空	角色	说明
1	`instrument_id`	`UInt64`	`integer`	no	default_order, warehouse_primary_key	WarrenHub canonical instrument identifier; use it for cross-dataset joins.标准术语表
2	`symbol`	`String`	`string`	no	filter	Display or trading symbol for the instrument.标准术语表
3	`market`	`LowCardinality(String)`	`string`	no	filter	Canonical market or country-market code.标准术语表
4	`asset_type`	`LowCardinality(String)`	`string`	no	filter	Instrument asset-class classification.标准术语表
5	`exchange`	`LowCardinality(String)`	`string`	no	filter	Listing or trading exchange.标准术语表
6	`name`	`String`	`string`	no	value	Canonical human-readable name.标准术语表
7	`name_en`	`String`	`string`	no	value	English human-readable name when available.标准术语表
8	`provider`	`LowCardinality(String)`	`string`	no	provenance	Upstream data provider identifier.标准术语表
9	`source_url`	`String`	`string`	no	provenance	URL of the upstream evidence or record when distributable.标准术语表
10	`source_record_id`	`String`	`string`	no	provenance	Provider-side identifier for the source record.标准术语表
11	`raw_payload_hash`	`String`	`string`	no	provenance	Opaque fingerprint of the normalized source payload for provenance checks.标准术语表
12	`parser_version`	`LowCardinality(String)`	`string`	no	provenance	Version of the parser or normalizer that produced the row.标准术语表
13	`quality_status`	`LowCardinality(String)`	`string`	no	provenance	Machine-readable data-quality classification.标准术语表
14	`license_scope`	`LowCardinality(String)`	`string`	no	provenance	License or redistribution scope attached to the row.标准术语表
15	`visibility_tier`	`LowCardinality(String)`	`string`	no	provenance	Serving visibility tier attached to the row.标准术语表
16	`ingest_run_id`	`String`	`string`	no	provenance	Identifier of the ingestion run that produced the row.标准术语表
17	`version`	`UInt64`	`integer`	no	provenance	Monotonic row version used for correction-aware reads.标准术语表
18	`is_deleted`	`UInt8`	`integer`	no	value	Soft-delete marker; public serving excludes current tombstones.标准术语表
19	`created_at`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	value	UTC timestamp when the warehouse row was first created.标准术语表
20	`updated_at`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	default_order	UTC timestamp when the warehouse row was last updated.标准术语表
21	`list_date`date	`Nullable(Date)`	`string / date`	yes	value	Calendar date for list date (YYYY-MM-DD).名称推导
22	`delist_date`date	`Nullable(Date)`	`string / date`	yes	value	Calendar date for delist date (YYYY-MM-DD).名称推导
23	`country`	`LowCardinality(String)`	`string`	no	value	Source-normalized field: country.名称推导
24	`currency`	`LowCardinality(String)`	`string`	no	value	ISO-like currency code for monetary values.标准术语表
25	`sector`	`LowCardinality(String)`	`string`	no	value	Source-normalized field: sector.名称推导
26	`industry`	`LowCardinality(String)`	`string`	no	value	Source-normalized field: industry.名称推导
27	`cusip`	`String`	`string`	no	value	Source-normalized field: cusip.名称推导
28	`isin`	`String`	`string`	no	value	Source-normalized field: isin.名称推导
29	`figi`	`String`	`string`	no	value	Source-normalized field: figi.名称推导
30	`is_active`	`UInt8`	`integer`	no	value	Whether active applies to the row.名称推导

字典口径

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