Crossmint Wallets icon

Crossmint Wallets

Interact with Crossmint Wallet APIs

Wallet → Get Balance

AI-generated

Summary

Retrieves the balance of specified tokens for a wallet address, email, user ID, phone number, or social handle.

Inputs

  • walletLocator (required) — Select the wallet using Address, Email, User ID, Phone, Twitter, or X handle.
  • chains (required) — Comma-separated list of blockchain networks (e.g., solana, solana-devnet).
  • tkn (required) — Comma-separated list of token symbols or names (e.g., sol, usdc).
  • balanceWalletChainType — Blockchain type required for locator modes other than Address (default: solana).

Output shape

A list of items, each containing balance data for the requested tokens on the specified chains.

The source code delegates to getWallet.operation.js, which calls the Crossmint API. The exact shape of the returned data depends on the Crossmint API response, which typically includes token balances per chain.

Examples

Example 1: Get SOL and USDC balance for a wallet address

Wallet: Address, Chains: solana, Tokens: sol,usdc

Example 2: Check balance for a user identified by email

Wallet: Email, Chain Type: solana, Chains: solana, Tokens: sol

Discussion