Get ledger summary
Reporting
Get ledger summary
Returns aggregated balances and flows per asset, optionally scoped to a program or asset and a time window.
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
API key passed in the X-API-Key header.
Query Parameters
Filter by program ID. May be combined with asset_id.
Filter to a single asset. May be combined with program_id.
Period start (inclusive, RFC3339). Must be provided with to.
Period end (inclusive, RFC3339). Must be provided with from.