---
title: "Create a report"
method: POST
path: "/reports"
tags: ["Reports (Beta)"]
---

# Create a report

`POST /reports`

## Request

- Base URL: `https://api.fireblocks.io/v1`
- URL: `https://api.fireblocks.io/v1/reports`
- Auth: none declared
- TypeScript: <https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/reports/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a new asynchronous report job and returns a receipt containing the report ID.
Poll `GET /v1/reports/{reportId}` to check status. When `status` is `COMPLETED`, the poll
response includes a fresh pre-signed download URL in `links.downloadUrl`.

**Note:** These endpoints are currently in beta and might be subject to changes.

Endpoint Permission: Viewer and above.

## Headers

- `Idempotency-Key` string

## Request body

- CreateReportRequest: Request body for creating a new ADDRESSES report job
  - `reportType` 'ADDRESSES', required: The type of report to generate.
  - `outputFormat` 'CSV', required: The output file format of the report
  - `compress` boolean: Gzip the output file. Defaults to true.
  - `filters` AddressesFilters: Filter options for the `addresses` report type.
    - `vaultAccountIds` string[]: Restrict to the listed vault account IDs. Max 1000 items. Pass a single ID as a one-element array.
    - `assets` string[]: Filter by asset symbol (e.g., BTC, ETH). Max 1000 items. Pass a single symbol as a one-element array.

## Response `202`

Report job accepted and queued for processing

- CreateReportResponse: Returned when a report job is successfully created. Use the `id` to poll for status via `GET /v1/reports/{reportId}`.
  - `id` string, required: Unique identifier of the report job

## Other responses

- `409`: A report with the same type and filters is already being processed
- `default`: Error Response

---

[API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)