Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id
string
required

Organization ID (UUID)

ledger_id
string
required

Ledger ID (UUID)

Query Parameters

period
string

Relative window: 7d, 30d or 90d (default: 30d). Mutually exclusive with start_date/end_date.

start_date
string

Window start (RFC3339, inclusive). Requires end_date. Mutually exclusive with period.

end_date
string

Window end (RFC3339, exclusive). Requires start_date. The window may not exceed 90 days.

Response

OK

byStatus
object
required
reversalsByAsset
object[] | null
required

The part of the gross volume made of reversal legs: settled transactions inside the window whose parent_transaction_id is set, per asset. A true net is not derivable from volume and reversals alone, because it depends on whether each reversed original also falls inside the window.

total
integer<int64>
required
Example:

1420

updatedAt
string<date-time>
required
volumeByAsset
object[] | null
required
windowEnd
string<date-time>
required
windowStart
string<date-time>
required