Financials

Get entity financials

Retrieve normalized financial data for an entity. Accepts UUID or ticker.

get/api/v1/entities/{entity_id}/financials

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/entities/{entity_id}/financials
  • Auth: HTTP bearer

Path parameters

entity_idstring required

Query parameters

yearsinteger

Number of years. 99 = all years available.

categorystring

Category filter

currencystring nullable

Display currency (ISO 4217, e.g. USD, EUR). Defaults to entity's native currency.

rate_methodstring

FX conversion method: 'ias21' (IAS 21 dual-rate, default), 'spot' (single closing rate), 'native' (no conversion).

constant_currency_base_yearinteger nullable

Translate all years using the base year's FX rate to isolate organic growth from currency moves. Each MetricValue returns reported_value + fx_impact alongside the constant-currency value.

end_yearinteger nullable

Anchor the rolling window at this fiscal year (inclusive). When set, the response returns up to years periods ending at end_year instead of the latest N.

tiersstring nullable

Comparability tier filter (comma-separated subset of core,extended,detail). Omit ⇒ serve every tier (each metric still carries its own tier in the envelope). A cross-entity consumer (compare / screener / SDK) passes tiers=core (or core,extended) to guarantee comparability. Fail-open: a metric whose tier is unknown is treated as core and never silently hidden.

viewstring

Payload shape. full (default) returns every field (audit / quality / provenance / per-cell FX metadata). compare returns only the comparison essentials (headline value + formatting + restatement flags + column-header metadata), dropping the audit metadata and every null field. ~8x smaller decoded — use it for cross-entity fan-out where full depth is reached on a follow-up single-entity call.

Response

Successful Response

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.