Accounts
Get a balance
Get a policy-gated account balance.
GET
/v1/agent-api/accounts/{id}/balancePath parameters
idstringRequiredResponses
200Account balance in USD at par across assets, with an optional breakdown by network and token
403Account not accessible under this policy
404Readable account not found
Response fields
accountIdstringRequiredbalancemoneyRequiredDeprecated alias of balances.total: USD at par across assets
balancesobjectRequiredbalances.totalmoneyRequiredUSD at par across assets on every account network, including networks this agent may not use
balances.availablemoneyRequiredAggregate unreserved funds in USD at par across assets on the networks this agent may use, leaving out a network Catena has closed. For a network-split account, this equals the sum of byNetwork available values. It describes the account and does not determine whether a particular payment can be funded. Zero while the account is not active, and zero when no network the account holds is open to agents.
balances.byNetworkarray of objectOptionalOne entry for each network that the account holds and agents may use. Their available values add up to balances.available. Their total values can add up to less than balances.total, which also counts a network agents may not use. Every available is zero while the account is not active. A network Catena has closed keeps its entry, with status closed and available zero. An empty array means no network the account holds is open to agents. Absent until the account's money is split by network.
balances.holdingsarray of objectOptionalOptional breakdown by network and token, in USD at par across assets. When absent, every figure is USDC. Omitted for bank accounts and until the account's money is split by network. Only networks this agent may use are included. Available values sum to balances.available; total values sum to balances.total only when every account network is inside the agent network fence. Closed networks and inactive accounts have zero available, and retired wallets contribute to total alone.