Export

Submit a background export of several companies

Builds ONE zip archive holding one XLSX workbook per company (the same workbook GET /entities/{id}/export streams) plus a README naming any company that could not be exported. Up to 100 companies per job, 3 jobs in progress and 20 archives or 2 GB held per workspace (409 EXPORT_QUOTA beyond). The archive lands in the workspace's deliverables zone and expires after 7 days. Requires the export.bulk scope, which the Team and Enterprise plans open (401 anonymous, 403 SCOPE_MISSING on any other plan). Poll GET /exports/{id} until status is ready, then call GET /exports/{id}/download: it redirects (307) to a signed URL valid 10 minutes. API clients must follow the redirect.

post/api/v1/exports

Request

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

Request body

entity_idsstring[] required

Companies to export, 1 to 100: UUIDs, tickers or TICKER.MIC (as GET /entities/{id}). Duplicates are dropped.

yearsinteger

Fiscal years per company, 99 for every year we hold.

categorystring

One of all, balance_sheet, cash_flow, income_statement, ratio.

xbrl'none' | 'core' | 'calculation' | 'full'

XBRL linkbase sheets to embed in each workbook, as GET /entities/{id}/export.

Example request

{
  "entity_ids": [
    "AAPL",
    "MC.XPAR",
    "JNJ"
  ]
}

Response

Job accepted; data.status is pending

successboolean required

Changes

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