Skip to main content

getTokenAccountBalance RPC Method

Returns the token balance of an KPL Token account.

Parameters​

string required Pubkey of Token account to query, as base-58 encoded string object optional Configuration object containing the following fields:

Result​

The result will be an RpcResponse JSON object with value equal to a JSON object containing:

  • amount: <string> - the raw balance without decimals, a string representation of u64
  • decimals: <u8> - number of base 10 digits to the right of the decimal place
  • uiAmount: <number|null> - the balance, using mint-prescribed decimals DEPRECATED
  • uiAmountString: <string> - the balance as a string, using mint-prescribed decimals

For more details on returned data, the Token Balances Structure response from getBlock follows a similar structure.

Code sample​

curl https://testnet.koii.network -X POST -H "Content-Type: application/json" -d '
  {
    "jsonrpc": "2.0", "id": 1,
    "method": "getTokenAccountBalance",
    "params": [
      "7fUAJdStEuGbc3sM84cKRL6yYaaSstyLSU4ve5oovLS7"
    ]
  }
'

Response​

{
  "jsonrpc": "2.0",
  "result": {
    "context": {
      "slot": 1114
    },
    "value": {
      "amount": "9864",
      "decimals": 2,
      "uiAmount": 98.64,
      "uiAmountString": "98.64"
    },
    "id": 1
  }
}