Entities

Decompose a fact into rollup + linkbase + dimensional layers

Combines three layers of granularity for one fact in a single round-trip :

  • the parent fact (same shape as /facts/{code}),
  • the XBRL calculation linkbase children for the source filing (tree walked up to depth, per-filing forward provenance),
  • the dimensional breakdown (axis/member) of the same XBRL fact.

Provide EITHER hub_concept_code (Hub-Equity standardized) OR qname (raw XBRL, e.g. us-gaap:DeferredRevenueNoncurrent) — both are query params. depth 1-3 (default 1) walks the calc tree ; depth=2 is recommended so the breakdown lands in one call.

Premium layer: the signed components Hub-Equity uses for this figure (rollup_children) are returned only with the facts.premium scope (as for /filings/{id}/calculation-tree), and so are the dimensional members; other callers get the parent and the linkbase layer, with rollup_children and dimensional_breakdown empty + a note.

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

Request

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

Path parameters

entity_idstring required

Query parameters

fiscal_yearinteger required

Fiscal year (e.g. 2024).

hub_concept_codestring nullable

Hub concept code (e.g. REVENUE). Provide this OR qname.

qnamestring nullable

Raw XBRL qname (e.g. us-gaap:DeferredRevenueNoncurrent) for concepts without a hub mapping. Provide this OR hub_concept_code.

fiscal_period_typestring

FY (default, annual), Q1-Q4, or H1/H2.

depthinteger

Calc-linkbase tree depth (1-3, default 1). 2 is recommended for typical decomposition questions.

Response

The decomposition (parent + 3 layers).

successboolean required

Changes

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