Balances API

API endpoints

Balances API

Balance and journal endpoints expose ledger-backed projections for an account or wallet. Use them for product balances and reconciliation rather than calculating state only from WebSocket events.

Operations

MethodPathScopeDescription
GET/api/v1/ledger/accounts/{accountId}/balanceswallets:readAccount balances by chain and asset
GET/api/v1/wallets/{walletId}/balanceswallets:readWallet balances
GET/api/v1/wallets/{walletId}/ledger-entrieswallets:readWallet journal entries

Account balance fields

FieldMeaning
postedBalanceSettled accounting balance in atomic units
reservedBalanceAmount currently reserved by pending operations
availableBalanceAmount available after reservations
*DisplayHuman-readable representation using asset decimals
decimalsDecimal precision when known
displaySourceasset_config or atomic

Keep atomic values as strings. Do not parse them through floating-point types.

Filters

Account balances accept cursor, limit, chain, and asset. Wallet balances accept cursor, limit, and asset.

Wallet journal entries can be filtered by transactionId, status, direction, entryType, asset, createdFrom, and createdTo, in addition to cursor pagination.

Reconciliation rule

Use events as a trigger to refresh state, then read balances, transactions, and journal entries through REST. Persist the returned identifiers and timestamps so each movement can be traced end to end.