suix_getTotalSupply - Sui

Example code for the suix_getTotalSupply JSON-RPC method. Complete guide on how to use suix_getTotalSupply JSON-RPC in GetBlock Web3 documentation.

This method returns the total supply for a specified coin type on the SUI network. This method is useful for tokenomics analysis, market cap calculations, and monitoring token inflation or deflation over time. The supply value reflects the current total amount of the token in existence on-chain.

Parameters

Parameter

Type

Required

Description

coin_type

string

Yes

The fully qualified type name for the coin

Request Example

cURL

curl -X POST https://go.getblock.io/<ACCESS-TOKEN>/ \
-H "Content-Type: application/json" \
-d '{
  "jsonrpc": "2.0",
  "id": "getblock.io",
  "method": "suix_getTotalSupply",
  "params": ["0x2::sui::SUI"]
}'

example.js

const axios = require('axios');

const url = 'https://go.getblock.io/<ACCESS-TOKEN>/';

const payload = {
  jsonrpc: '2.0',
  id: 'getblock.io',
  method: 'suix_getTotalSupply',
  params: ['0x2::sui::SUI']
};

axios.post(url, payload, {
  headers: { 'Content-Type': 'application/json' }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

example.py

import requests
import json

url = "https://go.getblock.io/<ACCESS-TOKEN>/"

payload = {
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "method": "suix_getTotalSupply",
    "params": ["0x2::sui::SUI"]
}

response = requests.post(url, headers={"Content-Type": "application/json"}, json=payload)
print(response.json())

main.rs

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    
    let payload = json!({
        "jsonrpc": "2.0",
        "id": "getblock.io",
        "method": "suix_getTotalSupply",
        "params": ["0x2::sui::SUI"]
    });

    let response = client
        .post("https://go.getblock.io/<ACCESS-TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&payload)
        .send()
        .await?;

    let result: serde_json::Value = response.json().await?;
    println!("{:#?}", result);
    
    Ok(())
}

Response Example

response.json

{
  "jsonrpc": "2.0",
  "result": {
    "value": "10000000000000000000"
  },
  "id": "getblock.io"
}

Response Parameters

Parameter

Type

Description

value

string

Total circulating supply in the smallest unit

Use Cases

Calculate market capitalization for tokens
Monitor token supply changes over time
Analyze tokenomics and inflation rates
Build supply tracking dashboards
Verify token supply for audits

Error Handling

Error Code

Description

-32602

Invalid params - malformed coin type

-32603

Internal error - node processing issues

null result

Coin type does not have supply tracking

SDK Integration

typescript.ts

import { SuiClient } from '@mysten/sui/client';

const client = new SuiClient({ url: 'https://go.getblock.io/<ACCESS-TOKEN>/' });

const supply = await client.getTotalSupply({
  coinType: '0x2::sui::SUI',
});

console.log(supply);

rust.rs

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build("https://go.getblock.io/<ACCESS-TOKEN>/")
        .await?;
    
    let supply = sui.coin_read_api()
        .get_total_supply("0x2::sui::SUI".to_string())
        .await?;
    
    println!("{:?}", supply);
    Ok(())
}

Previoussuix_getOwnedObjects - Sui Nextsuix_getStakes - Sui

Last updated 1 day ago

Was this helpful?