Skip to main content

getTokenAccountBalance RPC Method

Returns the token balance of an SPL Token account.

Updated on
Apr 30, 2025

Parameters

pubkey
string

The Pubkey of token Mint to query encoded as base-58 string

object
object

The configuration object with the following fields:

commitment
string

The level of commitment required for the query. The options include:

finalized
string

The node will query the most recent block confirmed by the supermajority of the cluster as having reached maximum lockout, meaning the cluster has recognized this block as finalized

confirmed
string

The node will query the most recent block that has been voted on by the supermajority of the cluster

processed
string

The node will query its most recent block. Note that the block may not be complete

Returns

result

An object with the following fields:

context

The information about the current state of the program

apiVersion

The version of the Solana RPC API to use

slot

An integer representing the slot for which to retrieve the fee calculator

value

A JSON object with the following fields:

amount

The raw total token supply without decimals, a string representation of a u64 integer

decimals

An integer value representing the number of decimal places used by the token

uiAmount

The total token supply using mint-prescribed decimals (DEPRECATED)

uiAmountString

The total token supply as a string using mint-prescribed decimals

Request
Response
1
{
2
"jsonrpc": "2.0",
3
"result": {
4
"context": {
5
"apiVersion": "2.1.21",
6
"slot": 335501823
7
},
8
"value": {
9
"amount": "12",
10
"decimals": 0,
11
"uiAmount": 12,
12
"uiAmountString": "12"
13
}
14
},
15
"id": 1
16
}
1
{
2
"jsonrpc": "2.0",
3
"result": {
4
"context": {
5
"apiVersion": "2.1.21",
6
"slot": 335501823
7
},
8
"value": {
9
"amount": "12",
10
"decimals": 0,
11
"uiAmount": 12,
12
"uiAmountString": "12"
13
}
14
},
15
"id": 1
16
}
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free