DOCS


useNFTBalance

Defined in react-core/src/evm/hooks/async/nft.ts#L285

Get NFT balance of a specific wallet

function useNFTBalance(
  contract: RequiredParam<NFTContract>,
  ownerWalletAddress: RequiredParam<string>,
  tokenId?: RequiredParam<BigNumberish>,
): UseQueryResult<BigNumber, unknown>;

Parameters


Returns

a response object that includes the total balance of the owner

type ReturnType = UseQueryResult<BigNumber, unknown>;

Example

const {
  data: ownerBalance,
  isLoading,
  error,
} = useNFTBalance(contract, "{{wallet_address}}");
// for ERC1155 contracts, you can also pass a tokenId
const tokenId = 0;
const {
  data: ownerBalance,
  isLoading,
  error,
} = useNFTBalance(contract, "{{wallet_address}}", tokenId);