Reported and calculated values

Use metric_origins to classify each returned metric value. Do not infer origin from the metric name or from the catalog's general definition.

Metric origins

Ratios are derived by definition. Their formulas and dependencies live in the versioned metric catalog. is_derived_period describes the period itself and is separate from a metric's origin.

{
  "metrics": {
    "revenue": 125000000000,
    "net_change_in_cash": 9200000000
  },
  "metric_origins": {
    "revenue": "reported",
    "net_change_in_cash": "derived_line_item"
  }
}

Source detail levels

Set include_sources=true to return a sources map keyed like metrics.

• source_detail=reference returns compact stable identifiers suitable for lists and cached views.
• source_detail=full returns the complete public evidence available for the selected metric, including derivation operands where applicable.

For a derived value, inspect its derivation and operand references rather than presenting one operand as though it were the reported source of the derived result.

Render evidence

Use source endpoints only after selecting a metric's returned source identifiers:

GET /v1/companies/{company_id}/statement-cells/{cell_id}/source
GET /v1/companies/{company_id}/statement-cells/{cell_id}/geometry
GET /v1/companies/{company_id}/statement-table-values/{value_id}/source

Source renders return image/png. Geometry returns coordinates for highlighting the value in the filing page.

Restatements

is_restated=true means at least one value in the returned period came from a later filing's restated comparative. restated_metrics identifies exactly which metrics were restated. Do not label every value in the period as restated without checking that list.