GET
/
2025-06-09
/
wallets
/
{walletLocator}
/
balances
Get Wallet Balance
curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}/balances \
  --header 'X-API-KEY: <x-api-key>'
[
  {
    "symbol": "ETH",
    "decimals": 18,
    "amount": "18.8343253454",
    "rawAmount": "18834161225104097789",
    "chains": {
      "base": {
        "contractAddress": "0x123",
        "locator": "base:0x123",
        "amount": "18.833423432423",
        "rawAmount": "18834161225104097789"
      },
      "solana": {
        "mintHash": "123123",
        "locator": "solana:132",
        "amount": "0.000000000000000",
        "rawAmount": "00000000000000000"
      }
    }
  }
]
This is an alpha API and subject to change.

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
walletLocator
string
required

A wallet locator can be of the format:

  • <walletAddress>
  • email:<email>:<chainType>[:<walletType>] (walletType defaults to 'smart')
  • userId:<userId>:<chainType>[:<walletType>] (white label user example)
  • phoneNumber:<phoneNumber>:<chainType>[:<walletType>]
  • twitter:<handle>:<chainType>[:<walletType>]
  • x:<handle>:<chainType>[:<walletType>]
  • me:<chainType>[:<walletType>] (Use when calling from the client side with a client API key)

Query Parameters

​
chains
string

The blockchain(s) to query. Comma-separated list of chains

​
tokens
string
required

The tokens to query. Comma-separated list of either tokens or token locator strings

Response

Returns the balance of the wallet for the given chain and currency

Array of wallet balances per token

​
decimals
number
required

The number of decimals of the token

Example:

18

​
amount
string
required

The amount of the token after placing the decimal point

Example:

"18.8343253454"

​
rawAmount
string
required

The raw amount of the token

Example:

"18834161225104097789"

​
chains
object
required

Balance information per chain

Example:
{
  "base": {
    "contractAddress": "0x123",
    "locator": "base:0x123",
    "amount": "18.833423432423",
    "rawAmount": "18834161225104097789"
  },
  "solana": {
    "mintHash": "123123",
    "locator": "solana:132",
    "amount": "0",
    "rawAmount": "00000000000000000"
  }
}
​
symbol
string