| Tool |
Summary |
get_balance |
Read one coin’s liquid balance for a Sui address or object, now or at a past time/checkpoint; the default coin is SUI. |
get_coin_info |
Get on-chain metadata for a token/coin given its exact coin type string (e.g. ‘0x2::sui::SUI’). |
get_token_prices |
Get USD prices for Sui coins by full coin type, current by default or at a past moment when at is set. |
search_token |
Find a Sui coin type by name or symbol for get_balance, get_coin_info or get_token_prices. |
- Title: Get balance
- Profile:
core (default)
- Annotations:
openWorldHint: true, readOnlyHint: true
Read one coin’s liquid balance for a Sui address or object, now or at a past time/checkpoint; the default coin is SUI. The total includes Coin<T> objects and address-balance funds, so no coin objects does not mean no funds. Only its defining module can withdraw an object’s address balance. This excludes staking and DeFi positions: check get_staking_summary and get_defi_positions before assessing holdings; use get_wallet_overview for every coin. Historical reads are direct within the consistent range (about the last hour), reconstructed for older points and exact only when complete:true. Reconstruction stops at max_transactions; an incomplete result has balance:null and reached_checkpoint marks progress. Reconstructed coin_balance and address_balance are null; anchor has the split at its checkpoint.
| Parameter |
Type |
Required |
Description |
owner |
string |
no |
Owner address (0x…). Required; address is accepted in its place. |
address |
string |
no |
Alias for owner. |
coin_type |
string |
no |
Coin type (default: 0x2::sui::SUI) |
at_checkpoint |
integer (at least 0) |
no |
Balance as of the end of this checkpoint. Give this or at, not both. |
at |
string |
no |
ISO 8601 time: use the last checkpoint at or before it. Give this or at_checkpoint, not both. |
max_transactions |
integer (1 to 10000) |
no |
Reconstruction transaction limit (default 1000, max 10000); ignored for current or consistent-range reads. |
network |
mainnet | testnet | devnet |
no |
Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |
- Title: Get coin info
- Profile:
market
- Annotations:
openWorldHint: true, readOnlyHint: true
Get on-chain metadata for a token/coin given its exact coin type string (e.g. ‘0x2::sui::SUI’). Returns name, symbol, decimals, description, icon URL, and total supply. If you only have a name or symbol, use search_token first to find the coin type.
| Parameter |
Type |
Required |
Description |
coin_type |
string |
yes |
Coin type (e.g. 0x2::sui::SUI) |
network |
mainnet | testnet | devnet |
no |
Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |
- Title: Get token prices
- Profile:
core (default)
- Annotations:
openWorldHint: true, readOnlyHint: true
Get USD prices for Sui coins by full coin type, current by default or at a past moment when at is set. Needs no API key. Each price names its source, confidence and sample time, and each coin that could not be priced is listed under unpriced with the reason. The 24h change is null when DefiLlama lacks the current or day-earlier price. An unverified coin is priced only by its exact coin type, never by a symbol-matched feed.
| Parameter |
Type |
Required |
Description |
coin_types |
array of string (1 to 100 items) |
yes |
Full coin type strings, e.g. [‘0x2::sui::SUI’]. |
at |
number | string |
no |
Price at this moment, as Unix seconds or ISO 8601. Omit for current prices. |
network |
mainnet | testnet | devnet |
no |
Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |
- Title: Search token
- Profile:
market
- Annotations:
openWorldHint: true, readOnlyHint: true
Find a Sui coin type by name or symbol for get_balance, get_coin_info or get_token_prices. Verified types rank first, then exact symbol matches; verified means a curated list vouches for that exact type, not its copyable name. Mainnet’s unverified matches use a CoinMetadata/coin-registry symbol index dated by symbol_index.synced_at; later coins are missing. Symbols used by over 100 coins list only counts in unlisted_symbols, including symbols containing the query. With no index match, or off mainnet, discovery uses a bounded live CoinMetadata scan. discovery_scan_truncated means it did not finish; discovery_scan_failed names a read error.
| Parameter |
Type |
Required |
Description |
query |
string |
yes |
Token name, symbol (e.g. ‘USDC’, ‘WAL’), or full coin type (e.g. ‘0x…::mod::TOKEN’) |
verify_onchain |
boolean |
no |
If true, verify each match on-chain and include total supply (default: false) |
limit |
integer (1 to 500) |
no |
Matches returned (default 50, max 500); verified types then exact symbols. total_matches counts all matches. |
network |
mainnet | testnet | devnet |
no |
Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |