CoinReadApi

The CoinReadApi provides methods for querying coin-related data on the Sui network. All methods are in the suix namespace.

Methods

getCoins

Returns all Coin<coin_type> objects owned by an address.

SuiAddress

required

The owner’s Sui address

string

Optional type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC). Defaults to 0x2::sui::SUI if not specified

string

Optional paging cursor

usize

Maximum number of items per page

CoinPage

Paginated coin results

Show response fields

Coin[]

Array of coin objects

string

Cursor for next page

boolean

Whether more results exist

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getCoins",
    "params": [
      "0x...",
      "0x2::sui::SUI",
      null,
      10
    ]
  }'

getAllCoins

Returns all Coin objects owned by an address (all coin types).

SuiAddress

required

The owner’s Sui address

string

Optional paging cursor

usize

Maximum number of items per page

CoinPage

Paginated results with all coins of all types

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getAllCoins",
    "params": [
      "0x...",
      null,
      50
    ]
  }'

getBalance

Returns the total coin balance for one coin type, owned by the address.

SuiAddress

required

The owner’s Sui address

string

Optional type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC). Defaults to 0x2::sui::SUI if not specified

Balance

Balance information

Show response fields

string

The coin type

number

Number of coin objects

string

Total balance across all coin objects

object

Locked balance details

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getBalance",
    "params": [
      "0x...",
      "0x2::sui::SUI"
    ]
  }'

getAllBalances

Returns the total coin balance for all coin types owned by the address.

SuiAddress

required

The owner’s Sui address

Balance[]

Array of balance information for each coin type

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getAllBalances",
    "params": [
      "0x..."
    ]
  }'

getCoinMetadata

Returns metadata (symbol, decimals, etc.) for a coin type.

If the coin’s metadata was wrapped in the transaction that published its marker type, or the latest version is wrapped or deleted, it will not be found.

string

required

Type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)

SuiCoinMetadata

Coin metadata if found

Show response fields

number

Number of decimal places

string

Coin name

string

Coin symbol

string

Coin description

string

Icon URL if available

ObjectID

Metadata object ID

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getCoinMetadata",
    "params": [
      "0x2::sui::SUI"
    ]
  }'

getTotalSupply

Returns the total supply for a coin type.

string

required

Type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC)

Supply

Supply information

Show response fields

string

Total supply value

curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getTotalSupply",
    "params": [
      "0x2::sui::SUI"
    ]
  }'

Usage Example with Rust SDK

use sui_sdk::SuiClientBuilder;
use sui_types::base_types::SuiAddress;
use std::str::FromStr;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build("https://fullnode.mainnet.sui.io:443")
        .await?;
    
    let address = SuiAddress::from_str("0x...")?;
    
    // Get SUI balance
    let balance = sui.coin_read_api()
        .get_balance(address, None)
        .await?;
    
    println!("SUI Balance: {}", balance.total_balance);
    
    // Get all balances
    let all_balances = sui.coin_read_api()
        .get_all_balances(address)
        .await?;
    
    for balance in all_balances {
        println!("{}: {}", balance.coin_type, balance.total_balance);
    }
    
    // Get coin metadata
    let metadata = sui.coin_read_api()
        .get_coin_metadata("0x2::sui::SUI".to_string())
        .await?;
    
    if let Some(meta) = metadata {
        println!("Symbol: {}, Decimals: {}", meta.symbol, meta.decimals);
    }
    
    Ok(())
}

JSON-RPC API

Rust SDK

GraphQL API

Framework

CoinReadApi

Methods

getCoins

getAllCoins

getBalance

getAllBalances

getCoinMetadata

getTotalSupply

Usage Example with Rust SDK

​Methods

​getCoins

​getAllCoins

​getBalance

​getAllBalances

​getCoinMetadata

​getTotalSupply

​Usage Example with Rust SDK

Methods

getCoins

getAllCoins

getBalance

getAllBalances

getCoinMetadata

getTotalSupply

Usage Example with Rust SDK