get_user_balance
Check a user's token balance on a route to verify sufficient funds for cross-chain bridging or swapping. Returns holdings on origin and maximum bridgeable amount.
Instructions
Check a user's balance for a specific token on a route. Returns how much of the token the user holds on the origin chain and the maximum amount they can bridge/swap on this route.
Use this before quoting to verify the user has sufficient funds, or to show available balance context. Requires specifying both origin and destination chains since max bridgeable amount depends on the route.
Chain IDs can be numbers (8453) or names ('base', 'ethereum', 'arb', 'bitcoin', 'solana').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | Wallet address to check balance for. | |
| originChainId | Yes | Origin chain ID or name (e.g. 1, 'ethereum'). | |
| originCurrency | Yes | Token address or symbol on the origin chain (e.g. "USDC", "ETH"). For native tokens use: EVM "0x0000000000000000000000000000000000000000", Solana "11111111111111111111111111111111", Bitcoin "bc1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqmql8k8", Hyperliquid "0x00000000000000000000000000000000", Lighter "0". For other tokens, use the contract/mint address or look up via get_supported_tokens. | |
| destinationChainId | Yes | Destination chain ID or name (e.g. 8453, 'base'). | |
| destinationCurrency | Yes | Token address or symbol on the destination chain (e.g. "USDC", "ETH"). For native tokens use: EVM "0x0000000000000000000000000000000000000000", Solana "11111111111111111111111111111111", Bitcoin "bc1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqmql8k8", Hyperliquid "0x00000000000000000000000000000000", Lighter "0". For other tokens, use the contract/mint address or look up via get_supported_tokens. |