Skip to main content

useTokenBalance

Get the token balance of a specified wallet

Example

import { useProgram, useTokenBalance } from "@thirdweb-dev/react/solana";

export default function Component() {
const { program } = useProgram("{{program_address}}");
const { data: balance, isLoading } = useTokenBalance(program, "{{wallet_address}}");

return (
<p>{balance}</p>
)
}

Signature:

export declare function useTokenBalance(program: RequiredParam<Token>, walletAddress: RequiredParam<string>): import("@tanstack/react-query").UseQueryResult<{
value: string;
displayValue: string;
}, unknown>;

Parameters

ParameterTypeDescription
programRequiredParam<Token>The token program to get the balance on
walletAddressRequiredParam<string>The address of the wallet to get the balance of

Returns:

import("@tanstack/react-query").UseQueryResult<{ value: string; displayValue: string; }, unknown>