Export

Export entity financials

Generate and download XLSX file with financial data. Accepts UUID or ticker. Requires a signed-in session on a paid plan (scope export.write): 401 anonymous, 403 on the Free plan.

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

Request

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

Path parameters

entity_idstring required

Query parameters

yearsinteger

Number of fiscal years to include. Pass 99 (or any value ≥99) to request every available year — the response is capped by the data we actually hold for the entity.

categorystring

Category filter

xbrlstring

XBRL linkbase granularity to embed. none (default) embeds no linkbase. core adds the primary statements calculation tree (~70 arcs per filing). calculation adds every calculation arc (~200 per filing). full adds calculation + presentation (~800-1400 per filing). Adds one Calc FY{y} (and Pres FY{y} for full) sheet per exported filing, plus an Info XBRL structure section and a _XBRL filename token.

Response

XLSX file

unknown required

Changes

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