Entities

List XBRL axes + members reported by the entity (premium)

Discovery endpoint — returns the dimensional structure an entity reports : which XBRL axes are used, which members per axis, and which Hub metrics carry which axis. Each axis is tagged with its axis_kind (geography, segment, product, equity_rollforward, debt, fv_hierarchy, concentration, ppe, awards, generic) so callers can dispatch to the right downstream call without parsing qnames themselves.

Use this BEFORE calling /v1/entities/{id}/financials/breakdown?metric=… to discover what metrics support what drill-downs. metrics_using_axis per axis tells you which metric values are valid for the breakdown call on that axis.

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

Request

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

Path parameters

entity_idstring required

Response

Dimensions overview.

successboolean required

Changes

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