getTokenSupply RPC Method
Returns the total supply of an SPL Token type.Parameters
string
requiredPubkey of the token Mint to query
- Base-58 encoded string
object
optionalConfiguration object containing the following fields:commitment
string
optionalThe level of commitment desired when querying state
Result Details
The result is an RpcResponse JSON object withvalue
containing:
-
amount: <string>
- Raw total token supply without decimals
- String representation of u64 integer
- Represents the absolute number of tokens
-
decimals: <u8>
- Number of decimal places for the token
- Determines how the raw amount should be displayed
-
uiAmount: <number|null>
DEPRECATED- Total token supply using mint-prescribed decimals
- Will be removed in future versions
-
uiAmountString: <string>
- Total token supply as a string
- Formatted using mint-prescribed decimal places
Important Notes
- Provides comprehensive information about token supply
- Includes both raw and user-friendly token supply representations
- Decimals help in correct token amount interpretation