DATASET · ref

规范公司行为

ref.corporate_action

标的与映射

按证券、生效日和行为类型统一拆股、分红等公司行为，为复权和事件研究提供标准输入。

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

字段19

关键字段3

更新口径daily

时间列effective_date

单页上限5000

分页窄筛选

PIT不支持

规模1K-9K

WHAT IT ANSWERS

这张表适合回答什么

查询证券公司行为时间线
解释价格跳变
生成复权处理输入

GRAIN & TIME

一行代表什么

业务粒度: 每行代表“规范公司行为”的一条记录；逻辑粒度由 instrument_id × effective_date × action_type 共同确定。
时间口径: 以 effective_date 为主要查询时间轴；除下方限制特别说明外，时间戳按 UTC、日期按来源市场日历解释。
更新节奏: 通常按交易日或自然日更新；具体最新日期请以返回数据为准。

KEY FIELDS

先看这些字段

instrument_id: WarrenHub 统一证券标识；跨证券数据集优先用它联接。
effective_date: 公司行为或映射开始生效的日期。
action_type: 用于确定该表业务粒度或默认顺序的 action type 字段。

RECOMMENDED JOINS

怎样和其他表关联

ref.instrumenton instrument_id

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

HOW TO QUERY SAFELY

查询方法与已知限制

先用 catalog 确认当前契约；可按 catalog 中列出的 filters 进一步缩小范围；单页最多 5000 行，该表不提供稳定 cursor，结果过大时必须缩小标的、日期或其他筛选。

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

MACHINE CONTRACT

筛选、排序与分页

UNVERSIONED

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

可用 filters

action_type→ action_type · string

instrument_id→ instrument_id · integer

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/corporate_action/rows?limit=100&instrument_id=1&start=2026-08-01&end=2026-08-01"

PYTHON SDK

from friends_data_api import FriendsDataClient, Settings

async with FriendsDataClient(Settings.from_env()) as client:
    page = await client.get_dataset_rows('ref', 'corporate_action', limit=100, start='2026-08-01', end='2026-08-01', filters={'instrument_id': 1})
    print(page.data)
    if page.has_more:
        print("next cursor:", page.next_cursor)

CLI

friends-data get-dataset-rows ref corporate_action --limit 100 --start 2026-08-01 --end 2026-08-01 --filter instrument_id=1

MCP TOOL CALL

{
  "arguments": {
    "dataset": "corporate_action",
    "end": "2026-08-01",
    "filters": {
      "instrument_id": 1
    },
    "limit": 100,
    "namespace": "ref",
    "start": "2026-08-01"
  },
  "tool": "get_dataset_rows"
}

FIELD DICTIONARY

19 个返回字段

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

筛选字段

#	字段	ClickHouse 类型	JSON	可空	角色	说明
1	`instrument_id`	`UInt64`	`integer`	no	filter, default_order, warehouse_primary_key	WarrenHub canonical instrument identifier; use it for cross-dataset joins.标准术语表
2	`effective_date`date	`Date`	`string / date`	no	time, default_order, warehouse_primary_key	Date on which the record or action becomes effective.标准术语表
3	`action_type`	`LowCardinality(String)`	`string`	no	filter, warehouse_primary_key	Source-normalized field: action type.名称推导
4	`ratio_numerator`	`UInt32`	`integer`	no	value	Source-normalized field: ratio numerator.名称推导
5	`ratio_denominator`	`UInt32`	`integer`	no	value	Source-normalized field: ratio denominator.名称推导
6	`description`	`String`	`string`	no	value	Human-readable description supplied or normalized from the source.标准术语表
7	`provider`	`LowCardinality(String)`	`string`	no	provenance	Upstream data provider identifier.标准术语表
8	`source_url`	`String`	`string`	no	provenance	URL of the upstream evidence or record when distributable.标准术语表
9	`source_record_id`	`String`	`string`	no	provenance	Provider-side identifier for the source record.标准术语表
10	`raw_payload_hash`	`String`	`string`	no	provenance	Opaque fingerprint of the normalized source payload for provenance checks.标准术语表
11	`parser_version`	`LowCardinality(String)`	`string`	no	provenance	Version of the parser or normalizer that produced the row.标准术语表
12	`quality_status`	`LowCardinality(String)`	`string`	no	provenance	Machine-readable data-quality classification.标准术语表
13	`license_scope`	`LowCardinality(String)`	`string`	no	provenance	License or redistribution scope attached to the row.标准术语表
14	`visibility_tier`	`LowCardinality(String)`	`string`	no	provenance	Serving visibility tier attached to the row.标准术语表
15	`ingest_run_id`	`String`	`string`	no	provenance	Identifier of the ingestion run that produced the row.标准术语表
16	`version`	`UInt64`	`integer`	no	provenance	Monotonic row version used for correction-aware reads.标准术语表
17	`is_deleted`	`UInt8`	`integer`	no	value	Soft-delete marker; public serving excludes current tombstones.标准术语表
18	`created_at`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	value	UTC timestamp when the warehouse row was first created.标准术语表
19	`updated_at`UTC_datetime	`DateTime64(3, 'UTC')`	`string / date-time`	no	value	UTC timestamp when the warehouse row was last updated.标准术语表

字典口径

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