---
title: "Export entity financials"
method: GET
path: "/api/v1/entities/{entity_id}/export"
tags: ["Export"]
---

# Export entity financials

`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

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.

## Path parameters

- `entity_id` string, required

## Query parameters

- `years` integer: 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.
- `category` string: Category filter
- `xbrl` string: 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 `200`

XLSX file

- unknown

## Other responses

- `403`: The workspace's plan does not include the export
- `404`: Entity not found or no data
- `422`: Validation Error

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)