GET
/
v1-alpha2
/
wallets
/
{walletLocator}
/
balances
Get Wallet Balance
curl --request GET \
  --url https://staging.crossmint.com/api/v1-alpha2/wallets/{walletLocator}/balances \
  --header 'X-API-KEY: <x-api-key>'
[
  {
    "token": "usdc",
    "decimals": 6,
    "balances": {
      "base": "121000000",
      "ethereum": "121000000",
      "total": "242000000"
    }
  },
  {
    "token": "eth",
    "decimals": 18,
    "balances": {
      "ethereum": "1000000000000000000",
      "total": "1000000000000000000"
    }
  }
]
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>:<walletType>
  • userId:<userId>:<walletType>
  • userId:<userId>:<walletType> (white label user example)
  • phoneNumber:<phoneNumber>:<walletType>
  • twitter:<handle>:<walletType>
  • x:<handle>:<walletType>

Query Parameters

​
chains
string

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

​
tokens
string
required

The tokens to query. Comma-separated list

Response

200
application/json

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

The balances of the wallet