Financials

Get axis-grouped dimensional breakdown for an entity

Returns the dimensional decomposition of a metric grouped by XBRL axis. Includes reconciliation (sum_to_consolidated) and is_additive flag. Without the facts.premium scope, the axes are listed with their consolidated totals but members is empty.

metric is OPTIONAL. Omit it to let the service elect one it can actually render (metric_selection=auto_selected). Supply it and it is never replaced by another: an entity that does not tag that metric dimensionally yields the same metric with axes: [] and metric_selection=requested_not_dimensional, and available_metrics lists what it does tag. Read metric_selection, not just metric.

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

Request

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

Path parameters

entity_idstring required

Query parameters

metricstring nullable

Hub concept code. Omit to let the service elect a renderable one. A supplied code is served or reported as non-dimensional, never swapped for another.

yearsinteger

Lookback period

fiscal_yearinteger nullable

Optional single fiscal year

Response

Successful Response

successboolean required

Changes

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