Skip to main content

getTokenAccountBalance

Returns the token balance of an SPL token account.

Parameters​

  • address: (string) [required] - The base-58 encoded public key of the token account to query.
  • config: (object) [optional] - Configuration object with the following options:
    • commitment: (string) [optional] - The commitment level to use for the query. The default is finalized. Possible values are:
      • finalized - Queries the most recent block confirmed by a super majority of the cluster as having reached maximum lockout, meaning the cluster has recognized this block as finalized.
      • confirmed - Queries the most recent block that has been voted on by a super majority of the cluster.
      • processed - Queries its most recent block. The block may still be skipped by the cluster.

Returns​

result - An object with the following fields:

  • context - An object containing the following keys:
    • slot - The slot number of the block that was queried.
    • apiVersion - The API version used for the query.
  • value - An object with the following fields:
    • amount - The raw total token supply without decimals, a string representation of a 64-bit unsigned integer.
    • decimals - An integer value representing the number of decimal places used by the token.
    • uiAmount - Deprecated. The total token supply using mint-prescribed decimals.
    • uiAmountString - The total token supply as a string using mint-prescribed decimals.

Example​

Replace <YOUR-API-KEY> with your API key.

Request​

curl https://solana-mainnet.infura.io/v3/<YOUR-API-KEY> \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc": "2.0", "id": 1, "method": "getTokenAccountBalance", "params": ["3emsAVdmGKERbHjmGfQ6oZ1e35dkf5iYcS6U4CPKFVaa"]}'

Response​

{
  "jsonrpc": "2.0",
  "result": {
    "context": {
      "apiVersion": "2.1.16",
      "slot": 332462945
    },
    "value": {
      "amount": "344068629195906",
      "decimals": 6,
      "uiAmount": 344068629.195906,
      "uiAmountString": "344068629.195906"
    }
  },
  "id": 1
}
On this page