Skip to main content

getTokenLargestAccounts RPC Method

Returns the 20 largest accounts of a particular SPL Token type.

Parameters

string required
Pubkey of the token Mint to query
  • Base-58 encoded string
object optional
Configuration object containing the following fields:
commitment string optional
The level of commitment desired when querying state

Code Sample

Response

Result Details

The result is an RpcResponse JSON object with value containing an array of largest token accounts:
  • address: <string>
    • The address of the token account
    • Base-58 encoded Pubkey
  • amount: <string>
    • Raw token account balance without decimals
    • String representation of u64 integer
  • decimals: <u8>
    • Number of decimal places for the token
    • Determines how the raw amount should be displayed
  • uiAmount: <number|null> DEPRECATED
    • Token account balance using mint-prescribed decimals
    • Will be removed in future versions
  • uiAmountString: <string>
    • Token account balance as a string
    • Formatted using mint-prescribed decimal places

Important Notes

  • Returns the top 20 largest token accounts for a specific token Mint
  • Provides both raw and user-friendly token balance representations
  • Decimals help in correct token amount interpretation