Get Token Supply

🚧

This endpoint is still in the Beta stage.

Results

Valid Response

<object> - A JSON object containing the following fields:

• circulatingSupply:<number> | <null>, the on-chain circulating supply for the token
• tokenWithheldAmount:<number> | <null>, the withheld amount for tokens creation with the tokenExtension Program
• userTotalWithheldAmount:<number> | <null>, the total amount withheld in user's token accounts
• totalWithheldAmount:<number> | <null>, the total withheld amount calculated based on (tokenWithheldAmount + userTotalWithheldAmount)
• realCirculatingSupply:<number> | <null>, the actual supply in circulation calculated based on (circulatingSupply - totalWithheldAmount)
• decimals:<number> | <null>, the number of decimal places for this token

Example of a valid response:

{
  "circulatingSupply": 99995300644040580,
  "tokenWithheldAmount": 46075414699976650,
  "userTotalWithheldAmount": 50226562768892200,
  "totalWithheldAmount": 96301977468868850,
  "realCirculatingSupply": 3693323175171728,
  "decimals": 2
}

Invalid Response

<object> - a JSON object containing the following fields if the requested account doesn't exist

• code:<integer>, The error code
• message:<String>, An error message to indicate which part of the query went wrong
• status:<String>, The response status following the error code
  • 400 = Bad Request (client side)
  • 500 = Internal Server Error (server side)