OriginFold Docs
Website ↗
FundamentalsPlanned coverage

Canonical financial facts

fundamentals.facts.canonical

Reported values mapped to consistent concepts while retaining their source context.

Planned plan access
Research, Professional
Schema version
1.2.0
Record key
entity_id, accession_number, metric_id, period_end, available_at, mapping_version

How to request it

When this dataset appears in your account’s catalog, select its version, supported fields and exact entity identifiers. Set a short date range and an as_of time, then request a small page. The record key identifies a row; it is not necessarily the identifier accepted by the query filter.

HTTP request template

This is a template, not a currently available request. Fill each variable from the authenticated catalog and your intended query. The Explorer can generate a complete request for an available dataset.

GET /v1/data/fundamentals.facts.canonicalHTTP
curl --fail-with-body --get "$ORIGINFOLD_API_URL/v1/data/fundamentals.facts.canonical" \
  --header "Authorization: Bearer $ORIGINFOLD_API_KEY" \
  --data-urlencode "dataset_version=$DATASET_VERSION" \
  --data-urlencode "fields=$FIELDS" \
  --data-urlencode "entity_id=$ENTITY_ID" \
  --data-urlencode "start=$START_DATE" \
  --data-urlencode "end=$END_DATE" \
  --data-urlencode "as_of=$AS_OF" \
  --data-urlencode "limit=25"

See a complete illustrative HTTP and Python example, including what each request parameter means.

Field dictionary

nullable fields may be empty. An empty value is not zero. Types and definitions below come from the dataset schema; the released API may expose only a qualified subset.

FieldTypeMeaning
dataset_idstringLogical dataset identifier.
version_iduuidv7Immutable origin fragment version identifier; copy-forward manifests retain it without rewriting prior rows.
schema_versionsemverRow schema version.
source_idstringApproved official structured source identifier.
available_attimestamp_utcEarliest documented public source availability; never replaced by report or period time.
ingested_attimestamp_utcSuccessful structured acquisition time.
source_sha256sha256Checksum of the temporary or bounded structured source bytes.
source_urluriOfficial provider URL; never a local source-document URL.
parser_versionstringVersioned structured parser or method identifier.
quality_flagslist[string]Machine-readable quality and source caveats.
entity_idstringStable reporting entity identifier.
metric_idstringGoverned MarketWeave canonical metric identifier.
period_startdate
May be empty
Metric duration start.
period_enddateMetric period end.
valuedecimal128_38_10
May be empty
Canonical value without silent imputation; exact decimal128 precision 38, scale 10.
unitstringCanonical unit.
source_fact_idslist[string]Exact source facts used by the mapping.
mapping_versionstringVersioned mapping registry identifier.
confidencefloat64Mapping confidence from zero to one.
reason_codestringMapping or explicit missing/ambiguity reason.
accession_numberstringSource filing accession.

Understand observation time, availability and revisions · Limits and errors