Skip to main content
GET
Get ledger summary
Returns aggregated balances and flows for each asset: total_issued, total_redeemed, total_expired, total_forfeited, current_balance, participant_count, and the asset’s scale. All values are computed in real time from the ledger. Scope with program_id, asset_id, or both; omit both for org-wide totals. Add from and to for a per-asset period rollforward. Period redemption figures are gross; all-time total_redeemed is net of reversals.
For audit-grade period reporting with no residual bucket, use the liability rollforward. For usage patterns, see the Reporting guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

program_id
string<uuid>

Filter by program ID. May be combined with asset_id.

asset_id
string<uuid>

Filter to a single asset. May be combined with program_id.

from
string<date-time>

Period start (inclusive, RFC3339). Must be provided with to.

to
string<date-time>

Period end (inclusive, RFC3339). Must be provided with from.

Response

Ledger summaries

Ledger summary results

data
object[]

Per-asset ledger summaries

pagination
object

Pagination metadata for list responses