Check Balances

Retrieve and manage wallet balances using Crossmint’s APIs

Token Balances

Prerequisites

• Ensure you have a wallet created.
• API Key: Ensure you have an API key with the scopes: wallets.read and wallets:balance.read.

Retrieving Wallet Balances

React

import { useWallet } from '@crossmint/client-sdk-react-ui';

const { wallet } = useWallet();

const { nativeToken, usdc, tokens } = await wallet.balances(tokens);

Path Parameters

tokens · string[]

The tokens to get the balances for. This can be a token symbol or a token address.

Returns

balances · Balances

The balances of the wallet.

Show properties

nativeToken · TokenBalance

The native token balance.

Show properties

amount · string

The amount of the token in decimal format (e.g. "42.69").

rawAmount · string

The amount of the token in its smallest indivisible unit (e.g. 1000000 for 1 USDC when decimals = 6).

symbol · string

The symbol of the token (e.g. USDC, ETH, etc.).

contractAddress|mintHash · string

The contract address (EVM, Stellar) or mint hash (Solana) of the token.

decimals · number

The number of digits after the decimal point (e.g. 6 for USDC). rawAmount divided by 10 to the power of decimals gives the amount.

usdc · TokenBalance

The USDC balance.

Show properties

amount · string

The amount of the token in decimal format (e.g. "42.69").

rawAmount · string

The amount of the token in its smallest indivisible unit (e.g. 1000000 for 1 USDC when decimals = 6).

symbol · string

The symbol of the token (e.g. USDC, ETH, etc.).

contractAddress|mintHash · string

The contract address (EVM, Stellar) or mint hash (Solana) of the token.

decimals · number

The number of digits after the decimal point (e.g. 6 for USDC). rawAmount divided by 10 to the power of decimals gives the amount.

tokens · TokenBalance[]

The tokens balances.

Show properties

amount · string

The amount of the token in decimal format (e.g. "42.69").

rawAmount · string

The amount of the token in its smallest indivisible unit (e.g. 1000000 for 1 USDC when decimals = 6).

symbol · string

The symbol of the token (e.g. USDC, ETH, etc.).

contractAddress|mintHash · string

The contract address (EVM, Stellar) or mint hash (Solana) of the token.

decimals · number

The number of digits after the decimal point (e.g. 6 for USDC). rawAmount divided by 10 to the power of decimals gives the amount.