Getting Balances

Retrieve token balances for a wallet account on a specific network.

You can get the token balances for a wallet account by calling the getBalances function. This returns native and token balances for a single network, unlike getMultichainBalances which queries across multiple chains.

If you only need the native token balance, use getBalance instead.

Usage

import { getBalances } from '@dynamic-labs-sdk/client';

const balances = await getBalances({ walletAccount });

With options

import { getBalances } from '@dynamic-labs-sdk/client';

const balances = await getBalances({
  walletAccount,
  networkId: 137,
  includePrices: true,
  includeNative: true,
  filterSpamTokens: true,
  forceRefresh: true,
  whitelistedContracts: ['0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174'],
});

Parameters

Parameter	Type	Required	Description
walletAccount	WalletAccount	Yes	The wallet account to get the balances for
networkId	number	No	The network ID to query. Defaults to the active network
includePrices	boolean	No	Include token prices in the response
includeNative	boolean	No	Include the native token balance
filterSpamTokens	boolean	No	Filter out spam tokens (default: true)
forceRefresh	boolean	No	Force a refresh instead of using cached values
whitelistedContracts	string[]	No	Only return balances for these contract addresses

React

Fetch balances in a useEffect and refresh when the wallet account changes:

import { getBalances } from '@dynamic-labs-sdk/client';
import { useEffect, useState } from 'react';

function TokenBalances({ walletAccount }) {
  const [balances, setBalances] = useState([]);

  useEffect(() => {
    if (!walletAccount) return;
    getBalances({ walletAccount, includePrices: true }).then(setBalances);
  }, [walletAccount]);

  return (
    <ul>
      {balances.map((token) => (
        <li key={token.address ?? 'native'}>
          {token.symbol}: {token.balance}
        </li>
      ))}
    </ul>
  );
}

Response

Returns a Promise<TokenBalance[]> — an array of token balance objects.

Related functions

• Getting Balance - For native token balance only
• Getting Multichain Balances - For balances across multiple chains
• Getting the Wallet Account Given an Address and Chain
• Getting Active Network