1 of 8

Account APIs

getAccountInfo

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:

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: 'getAccountInfo',
        params: {
          network: 'testnet',
          mirrorNodeUrl: 'https://testnet.mirrornode.hedera.com'
          // Pass 'accountId' is useful if you want to retrieve account info 
          // 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 "mirrorNodeUrl", the snap will query the Hedera Ledger node to retrieve the account information and this may have some costs associated with the query. In addition, the token balance would also not be retrieved as that can only be retrieved from querying a mirror node.

If you want to retrieve the complete account data and want to do it for free, be sure to pass in "mirrorNodeUrl" in your parameter.

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 info for another account Id which you do not own. Think of this as fetching the account info of an arbitrary hedera account Id. To do that, you would just pass in accountId like this:

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

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'getAccountInfo',
        params: {
          network: 'testnet',
          mirrorNodeUrl: 'https://testnet.mirrornode.hedera.com'
          accountId: '0.0.1',
        }
      }
    }
  })
}

This would retrieve the account info of the account 0.0.1 from the Hedera Mirror Nodes.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Calls the Mirror Node Account Info REST API to get account info from the Hedera Mirror Node if mirrorNodeUrl is passed. If not, it calls the Get Account Info API of the Hedera SDK
Returns the result.

Some example responses:

For a hedera account id 0.0.4235873:

{
  "currentAccount": {
    "hederaAccountId": "0.0.4235873",
    "hederaEvmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "balance": {
      "hbars": 0.75108133,
      "timestamp": "Wed, 24 Jan 2024 21:58:32 GMT",
      "tokens": {}
    },
    "network": "mainnet"
  },
  "accountInfo": {
    "accountId": "0.0.4235873",
    "alias": "HORADX2QGFHEOAWU3EVVFUYE5ZR37SRD",
    "createdTime": "Mon, 11 Dec 2023 05:42:32 GMT",
    "expirationTime": "Sun, 10 Mar 2024 05:42:32 GMT",
    "memo": "lazy-created account",
    "evmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "key": {
      "type": "ECDSA_SECP256K1",
      "key": "0380f14bf0a7c8c8c0bbae90e4f6d18b8a016fa945ec646943e8d56a1f7e4dd02a"
    },
    "balance": {
      "hbars": 0.75108133,
      "timestamp": "Wed, 24 Jan 2024 21:58:32 GMT",
      "tokens": {}
    },
    "autoRenewPeriod": "7776000",
    "ethereumNonce": "0",
    "isDeleted": false,
    "stakingInfo": {
      "declineStakingReward": false,
      "stakePeriodStart": "",
      "pendingReward": "0",
      "stakedToMe": "0",
      "stakedAccountId": "",
      "stakedNodeId": ""
    }
  }
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ 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 FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.

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.

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:

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

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'getAccountBalance',
        params: {
          network: 'testnet',
          mirrorNodeUrl: 'https://testnet.mirrornode.hedera.com'
          accountId: '0.0.1',
        }
      }
    }
  })
}

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 snap account is created and the account info is saved in snap state.
Calls the Get Account Balance API to get account balance.
Returns the result.

Some example responses:

For a hedera account id 0.0.4559:

{
  "currentAccount": {
    "hederaAccountId": "0.0.4559",
    "hederaEvmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "balance": {
      "hbars": 89.60420503,
      "timestamp": "2024-02-01T21:35:21.826Z",
      "tokens": {}
    },
    "network": "testnet"
  },
  "accountBalance": 89.60420503
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ 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 FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.

stakeHbar

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:

You must pass in either "nodeId" or "accountId" but not both.

Note that you can also call this API to stake to another Account Id instead of a Node. To do that, you would just pass in accountId like this:

This would stake to the account Id 0.0.1.

This would make it so that you stop getting staking rewards.

What the API does

Returns the transaction receipt as response

Some example responses:

For a hedera account id 0.0.4559:

Stake Hbar Live Demo on CodePen

unstakeHbar

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 unstakeHbarAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'unstakeHbar',
        params: {
          network: 'testnet',
          nodeId: 0
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

To learn about what it means to stake to a node vs an account, please refer to Staking Info Documentation.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Calls the Hedera SDK Update Account API to change the property related to staking which means it will also update setDeclineStakingReward to true hence, the account will stop receiving staking rewards
Returns the transaction receipt as response

Some example responses:

For a hedera account id 0.0.4559:

{
  "currentAccount": {
    "hederaAccountId": "0.0.4559",
    "hederaEvmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "balance": {
      "hbars": 89.60420503,
      "timestamp": "2024-02-01T21:35:21.826Z",
      "tokens": {}
    },
    "network": "testnet"
  },
  "receipt": {
    "status": "SUCCESS",
    "accountId": "",
    "fileId": "",
    "contractId": "",
    "topicId": "",
    "tokenId": "",
    "scheduleId": "",
    "exchangeRate": {
      "hbars": 1,
      "cents": 12,
      "expirationTime": "Mon, 25 Nov 1963 17:31:44 GMT",
      "exchangeRateInCents": 12
    },
    "topicSequenceNumber": "0",
    "topicRunningHash": "",
    "totalSupply": "0",
    "scheduledTransactionId": "",
    "serials": [],
    "duplicates": [],
    "children": []
  }
}

Unstake Hbar Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ 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 FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.

approveAllowance

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 approveAllowanceAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'approveAllowance',
        params: {
          network: 'testnet',
          spenderAccountId: '0.0.67890', 
          amount: 25,
          assetType: 'HBAR', // 'HBAR' | 'TOKEN' | 'NFT'
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

For assetType TOKEN/NFT, you will need to pass in additional parameter assetDetail that contains the following:

type ApproveAllowanceAssetDetail = {
  assetId: string;
  all?: boolean;
}

Note that you can also call this API to approve allowance for other tokens and nfts.

For tokens, you would need to pass in additional parameters as shown below:

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

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'approveAllowance',
        params: {
          network: 'testnet',
          spenderAccountId: '0.0.67890', 
          amount: 25,
          assetType: 'TOKEN', 
          assetDetail: {
            assetId: '0.0.45634' // This is token ID
          }
        }
      }
    }
  })
}

For nfts, you would need to pass in additional parameters as shown below:

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

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'approveAllowance',
        params: {
          network: 'testnet',
          spenderAccountId: '0.0.67890', 
          amount: 25,
          assetType: 'NFT', 
          assetDetail: {
            assetId: '0.0.57894' // This is nft ID
            all: false, // If this is set to true, it will approve all the NFTs in the above collection
          }
        }
      }
    }
  })
}

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Calls the Hedera SDK Approve Allowance API that allows a token owner to delegate a token spender to spend the specified token amount on behalf of the token owner. The owner can provide an allowance for HBAR, fungible(TOKEN) and non-fungible(NFT) tokens.
Returns the transaction receipt as response.

Some example responses:

For a hedera account id 0.0.4559:

{
  "currentAccount": {
    "hederaAccountId": "0.0.4559",
    "hederaEvmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "balance": {
      "hbars": 89.60420503,
      "timestamp": "2024-02-01T21:35:21.826Z",
      "tokens": {}
    },
    "network": "testnet"
  },
  "receipt": {
    "status": "SUCCESS",
    "accountId": "",
    "fileId": "",
    "contractId": "",
    "topicId": "",
    "tokenId": "",
    "scheduleId": "",
    "exchangeRate": {
      "hbars": 1,
      "cents": 12,
      "expirationTime": "Mon, 25 Nov 1963 17:31:44 GMT",
      "exchangeRateInCents": 12
    },
    "topicSequenceNumber": "0",
    "topicRunningHash": "",
    "totalSupply": "0",
    "scheduledTransactionId": "",
    "serials": [],
    "duplicates": [],
    "children": []
  }
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ 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 FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.

deleteAllowance

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 deleteAllowanceAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'deleteAllowance',
        params: {
          network: 'testnet',
          assetType: 'HBAR', // 'HBAR' | 'TOKEN' | 'NFT'
          spenderAccountId: '0.0.67890', 
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

For assetType HBAR/TOKEN, you must pass the parameter spenderAccountId.

For asetType TOKEN/NFT, you must pass the parameter assetId that is either the token id or nft id.

Note that you can also call this API to delete allowance for other tokens and nfts.

For tokens, you would need to pass in additional parameters as shown below:

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

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'deleteAllowance',
        params: {
          network: 'testnet',
          assetType: 'TOKEN',
          spenderAccountId: '0.0.67890'
          assetId: '0.0.45634' // This is token ID
        }
      }
    }
  })
}

For nfts, you would need to pass in additional parameters as shown below:

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

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'approveAllowance',
        params: {
          network: 'testnet',
          assetType: 'NFT',
          assetId: '0.0.57894' // This is nft ID
        }
      }
    }
  })
}

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Calls the Hedera SDK Delete Allowance API that allows a token owner to delete allowances. For NFTs, deleteAllTokenNftAllowances is called to delete the allowances for the given NFT ID. For hbar and fungible tokens, approveTokenAllowance is called with the amount of 0 to delete the allowances.
Returns the transaction receipt as response.

Some example responses:

For a hedera account id 0.0.4559:

{
  "currentAccount": {
    "hederaAccountId": "0.0.4559",
    "hederaEvmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "balance": {
      "hbars": 89.60420503,
      "timestamp": "2024-02-01T21:35:21.826Z",
      "tokens": {}
    },
    "network": "testnet"
  },
  "receipt": {
    "status": "SUCCESS",
    "accountId": "",
    "fileId": "",
    "contractId": "",
    "topicId": "",
    "tokenId": "",
    "scheduleId": "",
    "exchangeRate": {
      "hbars": 1,
      "cents": 12,
      "expirationTime": "Mon, 25 Nov 1963 17:31:44 GMT",
      "exchangeRateInCents": 12
    },
    "topicSequenceNumber": "0",
    "topicRunningHash": "",
    "totalSupply": "0",
    "scheduledTransactionId": "",
    "serials": [],
    "duplicates": [],
    "children": []
  }
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ 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 FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.

deleteAccount

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 deleteAccountAPI = async () => {
  const externalAccountParams = {
    externalAccount: {
      accountIdOrEvmAddress: '0.0.12345',
      curve: 'ED25519'
    }
  }

  await window.ethereum.request({
    method: 'wallet_invokeSnap',
    params: {
      snapId,
      request: {
        method: 'deleteAccount',
        params: {
          network: 'testnet',
          transferAccountId: '0.0.67890', 
          /* 
            Uncomment the below line if you want to connect 
            to a non-metamask account
          */
          // ...externalAccountParams
        }
      }
    }
  })
}

Note that deleting an account is an irreversible action and the user can never re-activate it again and the user is prompted with a MetaMask dialog box to confirm their choice for additional security.

What the API does

Retrieves the currently connected account the user has selected on Metamask. If it's the first time, a new snap account is created and the account info is saved in snap state.
Calls the Hedera SDK Delete Account API that deletes an existing account from the Hedera Token. Before deleting an account, the existing HBAR is transferred to the account defined by transferAccountId. NOTE: Deleting an account is an irreversible action.
Returns the transaction receipt as response.

Some example responses:

For a hedera account id 0.0.4559:

{
  "currentAccount": {
    "hederaAccountId": "0.0.4559",
    "hederaEvmAddress": "0x3ba201df50314e4702d4d92b52d304ee63bfca23",
    "balance": {
      "hbars": 0,
      "timestamp": "2024-02-01T21:40:21.826Z",
      "tokens": {}
    },
    "network": "testnet"
  },
  "receipt": {
    "status": "SUCCESS",
    "accountId": "",
    "fileId": "",
    "contractId": "",
    "topicId": "",
    "tokenId": "",
    "scheduleId": "",
    "exchangeRate": {
      "hbars": 1,
      "cents": 12,
      "expirationTime": "Mon, 25 Nov 1963 17:31:44 GMT",
      "exchangeRateInCents": 12
    },
    "topicSequenceNumber": "0",
    "topicRunningHash": "",
    "totalSupply": "0",
    "scheduledTransactionId": "",
    "serials": [],
    "duplicates": [],
    "children": []
  }
}

Live Demo on CodePen

Note: Visit https://pulse.tuum.tech/ 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 FAQs section to learn about what you may be missing. You need to install Metamask in your browser for the live demo to work.
To ease the integration of Hedera Wallet Snap on an application, we have created a template web application that you can run locally and check out the code in its entirety to learn how you can integrate and interact with various APIs exposed by Hedera Wallet Snap. Check out the full source code at template application github repository.
You can also check out the API reference to learn how each API works.