Archive Data Types

Lirium generates daily reconciliation archives as CSV files. Each archive is identified by a date and a data_type, and you retrieve them with the Search Archives and Archive Details endpoints. This guide explains the data_type values available and what each file is for.

📘
Choosing a data_type
data_type is a query parameter on Search Archives and a path segment on Archive Details. When omitted on Search Archives it defaults to orders. A single date + data_type can be split across multiple files — always iterate the files array. See the Download Archive Files recipe for a complete download-and-verify loop.

Available data types

`data_type`	Granularity	What it answers
`orders`	One row per transaction	Every transaction that affected a settlement or Customer balance during the reporting window.
`customer_balances`	One row per Customer + currency	The balance each of your Customers held in each currency at the reporting cutoff.
`settlement_balances`	One row per currency	The balance of your pre-funding settlement account in each currency at the reporting cutoff.
`cold_storage`	One row per currency	How much of each asset should be held in cold storage versus hot liquidity.

`orders`

The default and most detailed archive. It contains one row per transaction that affected the Banking Partner's settlement account and/or a Customer's asset account within the day's reporting window (buy, sell, send, receive, swap, settlement top-ups, withdrawals, commissions, and fees).

Use it to reconcile movements transaction by transaction. The full column list, possible values, and the transaction types that populate each field are documented in the Archives reference.

`customer_balances`

A snapshot of every Customer's holdings per currency as of the reporting cutoff. One row is emitted for each Customer + currency combination that has a non-zero balance.

Field	Type	Required	Description
`customer_id`	string	Yes	Id of the Customer.
`reference_id`	string	No	The reference id you provided for the Customer.
`currency`	string	Yes	Currency of the balance (uppercase, e.g. `BTC`, `USDC`).
`balance`	string	Yes	The Customer's balance in that currency at the cutoff.
`last_movement`	ISO 8601 string	Yes	Timestamp of the last transaction that affected this balance.

Use it to reconcile the per-Customer liabilities you hold against Lirium.

`settlement_balances`

A snapshot of your pre-funding settlement account balances per currency as of the reporting cutoff. One row per currency.

Field	Type	Required	Description
`currency`	string	Yes	Currency of the settlement account (uppercase).
`balance`	string	Yes	Settlement account balance in that currency at the cutoff.
`last_movement`	ISO 8601 string	Yes	Timestamp of the last transaction that affected this balance.

Use it to reconcile the funds available in your settlement account across currencies.

`cold_storage`

A daily cold storage report that helps you decide how much of each asset to keep in cold storage versus available as hot liquidity. For each currency it compares your current cold storage balance against a target balance derived from your Customers' average holdings, a minimum-liquidity threshold, and a configured cold-storage percentage.

One row is emitted per currency. Amounts are expressed both in the asset's own units and in USD.

Field	Type	Required	Description
`currency`	string	Yes	Currency the row refers to (uppercase).
`rolling_average_balance`	string	Yes	Average total Customer balance over the rolling window.
`rolling_average_customers`	string	Yes	Average number of Customers holding the currency over the rolling window.
`last_day_balance`	string	Yes	Total Customer balance on the last day of the window.
`last_day_customers`	string	Yes	Number of Customers holding the currency on the last day.
`current_balance`	string	Yes	Amount currently held in cold storage.
`current_balance_in_usd`	string	Yes	`current_balance` valued in USD.
`calculation_usd_price`	string	Yes	USD price used for the calculation.
`calculation_min_liquidity`	string	Yes	Minimum USD liquidity to keep hot before allocating to cold storage.
`calculation_percentage_cold`	string	Yes	Configured percentage of the eligible balance to keep in cold storage.
`calculation_min_cold_balance`	string	Yes	Minimum USD amount below which nothing is allocated to cold storage.
`calculation_base_type`	string	Yes	Which balance drove the calculation: `last day` or `rolling`.
`calculation_base_balance`	string	Yes	The balance used as the calculation base (the lower of last-day and rolling).
`calculation_base_balance_in_usd`	string	Yes	`calculation_base_balance` valued in USD.
`calculation_target_balance_in_usd`	string	Yes	Computed target cold storage amount in USD before applying the minimum.
`target_balance_in_usd`	string	Yes	Final target cold storage amount in USD.
`target_balance`	string	Yes	Final target cold storage amount in the asset's own units.

🚧
Cold storage availability
The cold_storage archive requires per-currency configuration (minimum liquidity, cold-storage percentage, and minimum cold balance) to be set up for your domain. Contact [email protected] to enable it.

Reporting window and configuration

Archives are generated per date according to your reporting_cutoff_time, reporting_window, and timezone settings. See the Archives reference for how the window is computed and how to configure it.