Compare

Compare N entities × M metrics at one fiscal period — premium

Single round-trip comparison matrix with calendar-year fiscal alignment. Returns one row per entity with metadata (sector, country, auditor) + a cells map keyed by hub_concept_code → CompareCell {value, currency, period_start, period_end, fiscal_year, source filing}.

Periods are matched on the CALENDAR year of period_end (period_alignment = calendar_year), not on each issuer's fiscal year: for an issuer that does not close in December the value can differ from /api/v1/entities/{id}/financials for the same year, and fiscal_year on each cell says which fiscal year was served. A missing key means no consolidated value with a period_end in that calendar year: the issuer did not report it, or (52/53-week issuers closing in early January) its fiscal year closed in the next calendar year.

Caps 10×10. Consolidated values only (segment rows excluded), one value per (entity, concept).

post/api/v1/compare

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/compare
  • Auth: HTTP bearer

Request body

entity_idsstring[] required

Entities to compare (max 10): UUID, ticker or TICKER.MIC, as on every /entities/{id} route. An unknown identifier answers 404, an ambiguous ticker 409.

hub_concept_codesstring[] required

Hub-Equity standardized concept codes (max 10), e.g. ['REVENUE', 'NET_INCOME', 'TOTAL_ASSETS'].

fiscal_yearinteger required

Calendar year — for each issuer we pick the FY whose period_end falls in that year (Bloomberg / FactSet convention). Example : fiscal_year=2024 returns AAPL's FY ending Sep 2024, MSFT's FY ending Jun 2024, LVMH's FY ending Dec 2024.

fiscal_period_type'FY' | 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'H1' | 'H2'

Fiscal period type. Default 'FY' (full year). Other values are accepted for forward compatibility but currently force-overridden to 'FY' with a note in the response, since quarterly periods are not calendar-comparable across issuers (Apple Q1 ends Dec, MSFT Q1 ends Sep).

Response

Comparison matrix

successboolean required

Changes

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