Entities
Compute a hub value via roll-up (sum of components) for one period
Computes a figure for one period from the components the issuer reported, when the figure itself is not tagged. Returns the computed value with its source filing.
Always returns 200 with a result (value may be null when no leaf is materialized for the period).
Premium layer: the breakdown (algorithm + signed contributions) is returned only with the facts.premium scope. Other callers get the computed value + source with algorithm=unknown, contributions=[], and a note.
get/api/v1/entities/{entity_id}/roll-up/{hub_concept_code}
Request
- Base URL: https://api.hub-equity.com
- URL: https://api.hub-equity.com/api/v1/entities/{entity_id}/roll-up/{hub_concept_code}
- Auth: HTTP bearer
Path parameters
entity_idstring required
hub_concept_codestring required
Query parameters
fiscal_yearinteger required
Fiscal year (e.g. 2024).
fiscal_period_typestring
FY (default, annual), Q1-Q4, or H1/H2.
Response
The rolled-up value + (premium) rule breakdown.
Changes
No recorded changes to this operation across all 1 revision of this API.