Get group statement
Returns a running-balance statement of a group wallet’s ledger activity for one asset, with opening and closing balances for the window. When program_id is provided, movements and balances are scoped to that program’s journal entries.
asset_id query parameter is required. Each row represents one posting and includes the signed movement amount, bucket, journal entry, and running balance.
from and to select rows by the journal entry’s system ingestion time. They do not reset the running-balance calculation. opening_balance is the scoped balance immediately before from, and closing_balance is the scoped balance as of to. Pass bucket to scope rows and balances to AVAILABLE, HELD, or DEFERRED.
Pass program_id to scope movements, opening and closing balances, and running balances to journal entries attributed to that program. This filter follows journal activity attribution, not a lot’s original issuer lineage. Journal entries without a program_id, such as system-attributed activity, are excluded from a program-scoped statement.
A successful response contains data, opening_balance, closing_balance, and pagination. Treat missing or malformed fields as an error rather than substituting an empty movement list or zero balance.
Authorizations
API key passed in the X-API-Key header.
Path Parameters
Group ID
Query Parameters
Scope movements and balances to this program
Asset to produce the statement for
Scope the statement (rows and running balance) to a single bucket
AVAILABLE, HELD, DEFERRED Start of statement window (RFC 3339) — selects returned rows on system ingestion time
End of statement window (RFC 3339) — selects returned rows on system ingestion time
Maximum number of results (default 50, max 200)
x >= 1Pagination cursor from previous response
Response
Statement page with running balances
Asset the statement covers
"550e8400-e29b-41d4-a716-446655440000"
Bucket scope, when the statement was requested for a single bucket. Absent when the statement covers all buckets (running balance is then the total across buckets).
"AVAILABLE"
Scope balance as of the end of the window (the current balance when no to is given). Always equals the as-of(to) balance for the same entity/asset/bucket scope, regardless of pagination.
"350"
Statement lines, oldest first
Start of the statement window, when provided
"2024-01-01T00:00:00Z"
Scope balance immediately before the window ("0" when no from is given)
"250"
Pagination metadata for fetching subsequent statement pages
End of the statement window, when provided
"2024-02-01T00:00:00Z"