FIfireblocks
Reports (Beta)

Create a report

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.

post/reports

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

reportType'ADDRESSES' required

The type of report to generate.

outputFormat'CSV' required

The output file format of the report

compressboolean

Gzip the output file. Defaults to true.

Example request

{
  "reportType": "ADDRESSES",
  "outputFormat": "CSV",
  "compress": true,
  "filters": {
    "vaultAccountIds": [
      "1",
      "2"
    ],
    "assets": [
      "BTC",
      "ETH"
    ]
  }
}

Response

Report job accepted and queued for processing

idstring required

Unique identifier of the report job

Example response

{
  "id": "0190b3c2-7e4a-7c31-9f2a-1b6d8e5a0c11"
}

Changes

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