getWalletAddressBalances
Read exact raw balances for a wallet address.
Status
Proposed target SDK behavior for implementation. It is not an available SDK or an all-assets/network support claim.
Business action#
Read a balance snapshot for one authorized wallet address on one explicit network.
Proposed call#
getWalletAddressBalances(
input: GetWalletAddressBalancesInput,
options?: CallOptions,
): Promise<WalletBalanceSnapshot>
TypeScript uses walletId or the documented managed address field and network. Each exact base-unit amount is bigint in the SDK result and a canonical decimal string on the wire.
async def get_wallet_address_balances(
input: GetWalletAddressBalancesInput,
*,
options: CallOptions | None = None,
) -> WalletBalanceSnapshot: ...
Python uses wallet_id and network; base-unit amounts decode to arbitrary-precision int. A verified zero is 0, not None or an omitted asset.
GetWalletAddressBalances(
ctx context.Context,
input *GetWalletAddressBalancesInput,
) (*WalletBalanceSnapshot, error)
Go uses WalletID and Network; base-unit amounts are independent big.Int values decoded from canonical decimal strings. A failed read returns an error, not a zero-value snapshot.
Required input: wallet ID or managed address and exact network. The authenticated actor context supplies tenant/owner scope and the backend enforces it independently.
Result#
A timestamped balance snapshot with asset identity, exact base-unit amount, precision metadata and coverage/freshness information. It is not a cross-network portfolio, transaction history, fund reservation or spend guarantee.
Effects and failures#
Read-only. Unsupported coverage, unavailable data and absent assets remain distinguishable from verified zero. Holdings may change after the snapshot. Monetary values never require floating-point conversion.
Acceptance#
- Positive: every returned asset and amount is attributable to the requested wallet, network and snapshot boundary.
- Negative: failure cannot become zero; foreign wallets disclose nothing; a balance read cannot reserve or transfer funds.
See sendTransaction.