How to Use getTokenSupply

​

Common Use Cases

• Displaying Token Information: Showing the total supply of a token on an explorer or in a wallet interface.
• Tokenomics Analysis: Understanding the maximum or current total issuance of a token.
• Verification: Checking the supply of a token as reported by the mint account itself.
• Monitoring Supply Changes: If a token is mintable, this can be used to track changes in its total supply over time (though for fungible tokens, the supply is usually fixed or managed by a minting authority).

​

Request Parameters

1. mintAddress (string, required): The base-58 encoded public key of the token mint whose total supply you want to query.
2. options (object, optional): An optional configuration object that can include:
   • commitment (string, optional): Specifies the commitment level for the query (e.g., "finalized", "confirmed", "processed").

​

Response Structure

• amount (string): The total supply of the token in its smallest denomination (raw amount), as a string. This value is not adjusted for decimals.
• decimals (u8): The number of decimal places defined for this token mint. This is crucial for converting the raw amount to a human-readable format.
• uiAmount (number | null): The total supply of the token as a floating-point number, adjusted for the token’s decimals. This field might be null or less precise; uiAmountString is generally preferred for display.
• uiAmountString (string): The total supply of the token as a string, adjusted for the token’s decimals. This is the most user-friendly representation of the total supply.

{
  "jsonrpc": "2.0",
  "result": {
    "context": { "slot": 123456789 },
    "value": {
      "amount": "1000000000000000", // e.g., 1,000,000,000 tokens with 6 decimals
      "decimals": 6,
      "uiAmount": 1000000000.0,
      "uiAmountString": "1000000000.0"
    }
  },
  "id": 1
}

​

Code Examples

# Replace <TOKEN_MINT_PUBKEY> with the actual mint address
curl -X POST -H "Content-Type: application/json" -d \
  '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "getTokenSupply",
    "params": [
      "<TOKEN_MINT_PUBKEY>"
    ]
  }' \
  <YOUR_RPC_URL>

# Example with commitment level
curl -X POST -H "Content-Type: application/json" -d \
  '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "getTokenSupply",
    "params": [
      "<TOKEN_MINT_PUBKEY>",
      { "commitment": "confirmed" }
    ]
  }' \
  <YOUR_RPC_URL>

​

Developer Tips

• Immutable Supply (Usually): For most SPL tokens, once minted, the total supply from the perspective of the mint account itself is fixed unless the mint has a specific minting authority that can create more tokens (or burn them, though burning typically happens from token accounts, not the mint’s supply directly).
• decimals is Key: Always use the decimals field to correctly interpret the amount or uiAmountString.
• Data Source: This method queries the mint account directly for its supply information.