Friends Data API独立数据服务

DATASET · fundamental

标准化 XBRL 财务指标

fundamental.xbrl_metric_normalized
财务与估值

这是财务报表、估值与分析师预期中的“标准化 XBRL 财务指标”数据集;一行由 entity_id、metric、period_end、fiscal_period 定位,主要字段包括 accession_no、ticker、market、instrument_id、statement_type。

字段36
关键字段6
更新口径weekly
时间列filing_date
单页上限5000
分页Cursor
PIT不支持
规模1M-9M

WHAT IT ANSWERS

这张表适合回答什么

  • 比较公司财务与分析师预期
  • 构建基本面筛选和历史回测输入

GRAIN & TIME

一行代表什么

业务粒度
每行代表“标准化 XBRL 财务指标”的一条记录;逻辑粒度由 entity_id × metric × period_end 共同确定。
时间口径
以 filing_date 为主要查询时间轴;除下方限制特别说明外,时间戳按 UTC、日期按来源市场日历解释。
更新节奏
通常每周随上游披露或批处理更新;不是实时数据。

KEY FIELDS

先看这些字段

entity_id
用于识别 entity 的业务标识。
metric
长表中的机器可读指标名。
period_end
用于确定该表业务粒度或默认顺序的 period end 字段。
fiscal_period
用于确定该表业务粒度或默认顺序的 fiscal period 字段。
accession_no
SEC 对单次申报分配的唯一 accession number。
source_fact_record_id
用于识别 source fact record 的业务标识。

RECOMMENDED JOINS

怎样和其他表关联

ref.instrumenton instrument_id

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

HOW TO QUERY SAFELY

查询方法与已知限制

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

MACHINE CONTRACT

筛选、排序与分页

UNVERSIONED
默认排序
entity_id, metric, period_end, fiscal_period, accession_no, source_fact_record_id
唯一键
entity_id, metric, period_end, fiscal_period, accession_no, source_fact_record_id
读取模式
canonical_final_active
最大时间窗
未单独限制

可用 filters

accession_no→ accession_no · string
fiscal_year→ fiscal_year · integer
instrument_id→ instrument_id · integer
market→ market · string
metric→ metric · string
period_type→ period_type · string
provider→ provider · string
source→ source · string
ticker→ ticker · 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/fundamental/xbrl_metric_normalized/rows?limit=100&instrument_id=1"

FIELD DICTIONARY

36 个返回字段

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

#字段ClickHouse 类型JSON可空角色说明
1entity_idStringstringnodefault_order, warehouse_primary_key, contract_unique_keyIdentifier for entity.名称推导
2accession_noStringstringnofilter, default_order, warehouse_primary_key, contract_unique_keySEC accession number identifying one filing submission.标准术语表
3tickerStringstringnofilterTicker symbol reported by the source or mapped security master.标准术语表
4marketLowCardinality(String)stringnofilterCanonical market or country-market code.标准术语表
5instrument_idNullable(UInt64)integeryesfilterWarrenHub canonical instrument identifier; use it for cross-dataset joins.标准术语表
6metricLowCardinality(String)stringnofilter, default_order, warehouse_primary_key, contract_unique_keyMachine-readable metric name.标准术语表
7statement_typeLowCardinality(String)stringnovalueSource-normalized field: statement type.名称推导
8taxonomyLowCardinality(String)stringnovalueSource-normalized field: taxonomy.名称推导
9source_conceptStringstringnovalueSource-normalized field: source concept.名称推导
10concept_priorityUInt16integernovalueSource-normalized field: concept priority.名称推导
11period_startNullable(Date)string / dateyesvalueSource-normalized field: period start.名称推导
12period_endDatestring / datenodefault_order, warehouse_primary_key, contract_unique_keySource-normalized field: period end.名称推导
13filing_datedateNullable(Date)string / dateyestimeDate on which the filing was submitted or published.标准术语表
14fiscal_yearNullable(Int32)integeryesfilterSource-normalized field: fiscal year.名称推导
15fiscal_periodLowCardinality(String)stringnodefault_order, warehouse_primary_key, contract_unique_keySource-normalized field: fiscal period.名称推导
16period_typeLowCardinality(String)stringnofilterReporting-period classification such as annual or quarterly.标准术语表
17unitLowCardinality(String)stringnovalueUnit attached to the numeric observation.标准术语表
18normalized_unitLowCardinality(String)stringnovalueSource-normalized field: normalized unit.名称推导
19valueNullable(Float64)numberyesvalueNumeric or source-normalized value for the metric.标准术语表
20metric_valueNullable(Float64)numberyesvalueSource-normalized field: metric value.名称推导
21quality_statusLowCardinality(String)stringnoprovenanceMachine-readable data-quality classification.标准术语表
22quality_reasonStringstringnovalueSource-normalized field: quality reason.名称推导
23source_fact_record_idStringstringnodefault_order, warehouse_primary_key, contract_unique_keyIdentifier for source fact record.名称推导
24sourceLowCardinality(String)stringnofilter, provenanceNormalized upstream source identifier.标准术语表
25providerLowCardinality(String)stringnofilter, provenanceUpstream data provider identifier.标准术语表
26source_urlStringstringnoprovenanceURL of the upstream evidence or record when distributable.标准术语表
27source_record_idStringstringnoprovenanceProvider-side identifier for the source record.标准术语表
28raw_payload_hashStringstringnoprovenanceOpaque fingerprint of the normalized source payload for provenance checks.标准术语表
29parser_versionLowCardinality(String)stringnoprovenanceVersion of the parser or normalizer that produced the row.标准术语表
30license_scopeLowCardinality(String)stringnoprovenanceLicense or redistribution scope attached to the row.标准术语表
31visibility_tierLowCardinality(String)stringnoprovenanceServing visibility tier attached to the row.标准术语表
32ingest_run_idStringstringnoprovenanceIdentifier of the ingestion run that produced the row.标准术语表
33versionUInt64integernoprovenanceMonotonic row version used for correction-aware reads.标准术语表
34is_deletedUInt8integernovalueSoft-delete marker; public serving excludes current tombstones.标准术语表
35created_atUTC_datetimeDateTime64(3, 'UTC')string / date-timenovalueUTC timestamp when the warehouse row was first created.标准术语表
36updated_atUTC_datetimeDateTime64(3, 'UTC')string / date-timenovalueUTC timestamp when the warehouse row was last updated.标准术语表
字典口径

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