v1

latestOpenAPI 3.0.02026-07-26103425558.9 KB

Wallet

Retrieve wallet balance

Get the latest balance of a user's wallet, including details like the blockchain network and currency.

get/v2/users/{userId}/wallets/balance

Path parameters

userIdstring required

ID of the user

Query parameters

chain'POLYGON' | 'ETHEREUM' | 'SOLANA' | 'BASE' | 'TRON' required

The blockchain network to retrieve the wallet balance from.

currency'usdc' | 'usdt' | 'usdg' | 'pyusd' required

The type of currency to check the balance for.

Response

Success

balancestring

The raw balance of the wallet expressed in the smallest denomination of the token. This format is ideal for backend calculations, automation processes, or when precise, unrounded figures are necessary for smart contract interactions. For example, use this when calculating transaction fees or performing token transfer operations that require exact values.

displayBalancestring

The wallet balance formatted as a decimal string for display purposes, adjusted according to the token's decimal places to facilitate human readability. This format is best used in user interfaces where balances are displayed to end-users, such as in wallet apps or dashboards, where readability and familiarity are crucial. For instance, displaying an account balance on a user's home screen or summary page.