1 of 1

getAccountBalance

How to call the API from an app

Hedera Wallet Snap connects to your currently connected Metamask account by default. To learn how apps can connect to Hedera Wallet Snap using a non-metamask(external) account, refer to this documentation.

Then, depending on whether you're trying to connect to a metamask account or a non-metamask account, you can call the snap API in the following way:

If you don't pass in "accountId", it will retrieve account info for the currently connected account.

Note that you can also call this API to retrieve account balance for another account Id which you do not own. Think of this as fetching the account balance of an arbitrary hedera account Id. To do that, you would just pass in accountId like this:

This would retrieve the account balance of the account 0.0.1 from the Hedera Network Nodes.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new is created and the account info is saved in snap state.
Calls the to get account balance.
Returns the result.

Some example responses:

For a hedera account id 0.0.4559:

Live Demo on CodePen

Note: Visit to activate your hedera account before you interact with the demo
If you're getting any errors with the live demo, make sure you go through the section to learn about what you may be missing. You need to install in your browser for the live demo to work.

getAccountBalance

How to call the API from an app

Then, depending on whether you're trying to connect to a metamask account or a non-metamask account, you can call the snap API in the following way:

const snapId = `npm:@hashgraph/hedera-wallet-snap`

const getAccountInfoAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'getAccountBalance',
        params: {
          network: 'testnet',
          mirrorNodeUrl: 'https://testnet.mirrornode.hedera.com'
          // Pass 'accountId' is useful if you want to retrieve account balance
          // for someone else rather than yourself
          accountId: '0.0.67890', 
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

If you don't pass in "accountId", it will retrieve account info for the currently connected account.

This would retrieve the account balance of the account 0.0.1 from the Hedera Network Nodes.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new is created and the account info is saved in snap state.
Calls the to get account balance.
Returns the result.

Some example responses:

For a hedera account id 0.0.4559:

Live Demo on CodePen

Note: Visit to activate your hedera account before you interact with the demo
If you're getting any errors with the live demo, make sure you go through the section to learn about what you may be missing. You need to install in your browser for the live demo to work.

const snapId = `npm:@hashgraph/hedera-wallet-snap`

const getAccountInfoAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'getAccountBalance',
        params: {
          network: 'testnet',
          mirrorNodeUrl: 'https://testnet.mirrornode.hedera.com'
          // Pass 'accountId' is useful if you want to retrieve account balance
          // for someone else rather than yourself
          accountId: '0.0.67890', 
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

getAccountBalance

hashtagHow to call the API from an app

hashtagWhat the API does

hashtagLive Demo on CodePen

getAccountBalance

hashtagHow to call the API from an app

hashtagWhat the API does

hashtagLive Demo on CodePen

How to call the API from an app

What the API does

Live Demo on CodePen

How to call the API from an app

What the API does

Live Demo on CodePen