Skip to main content

getTokenAccountBalance RPC Method

Returns the token balance of an SPL Token account.

Updated on
Sep 20, 2024

getTokenAccountBalance RPC Method

Parameters

pubkey
string
The Pubkey of token Mint to query encoded as base-58 string
object
array
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
1
curl https://docs-demo.solana-mainnet.quiknode.pro/ \
2
-X POST \
3
-H "Content-Type: application/json" \
4
--data '{"jsonrpc":"2.0", "id":1, "method":"getTokenAccountBalance", "params": ["DhzDoryP2a4rMK2bcWwJxrE2uW6ir81ES8ZwJJPPpxDN"]}'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free