Skip to content

Recommended starting points

Tool Summary
analyze_token Analyze a Sui coin type or symbol: metadata, current price, 24h change, supply, top holders and current pool-liquidity custody.
get_transaction_history Read a wallet’s decoded protocols, actions and coin flows; prefer this to query_transactions for exploring activity.
get_wallet_overview Overview of a Sui wallet.
get_wallet_packages List package versions created by publish or upgrade transactions sent from this wallet address.
identify_address Classify a Sui address as wallet, package, validator or object before choosing other tools.
  • Title: Analyze token
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true

(Recommended for token research) Analyze a Sui coin type or symbol: metadata, current price, 24h change, supply, top holders and current pool-liquidity custody. Verified symbols resolve from the curated list; other mainnet symbols use DexScreener and GeckoTerminal searches confirmed on chain, several exact matches return ambiguous_symbol, and a provider cap or failed confirmation is reported, not read as an absent coin. Pool search covers SUI and native-USDC pairs with per-venue failure reporting. Liquidity custody scans the three pools with the largest SUI or USDC reserve; a stopped holder scan never establishes ownership concentration. Set include_liquidity false to skip pool reads.

Parameter Type Required Description
query string yes Symbol (‘deep’) or full coin type (‘0x2::sui::SUI’). A symbol matches exactly, in any case; use search_token for partial names.
include_holders boolean no Include top 5 holders (default: true). Set false for faster response.
holder_max_scan integer (1 to 50000) no Coin objects and address balances scanned per holder walk (default 2000, max 50000).
holder_time_budget_ms integer (1000 to 600000) no Holder scan wall-clock budget in milliseconds (default 35000, max 600000).
include_liquidity boolean no Inspect current liquidity and its LP or position holders in up to three discovered pools (default: true). Set false for metadata-only calls.
liquidity_pool_offset integer (at least 0) no Start at this discovered pool after ranking by its current SUI or USDC reserve (default 0).
liquidity_holder_pool string no For a holder continuation, restrict the page to this discovered pool ID.
liquidity_offset integer (at least 0) no Start at this holder index within liquidity_holder_pool (default 0).
liquidity_flagged_done boolean no Holder-page continuation marker; keep the value from omitted.next_call to avoid repeating flagged holders.
liquidity_max_scan integer (1 to 100000) no Max LP coins or position objects scanned per pool (default 1000, max 100000); follow liquidity_custody.pools[].scan.next_call after a bound.
liquidity_time_budget_ms integer (1000 to 600000) no Wall-clock budget for pool position scans in milliseconds (default 35000, max 600000).
liquidity_venue string no Search one venue; use pool_discovery.venues[].next_call to continue a bounded venue search.
liquidity_venue_cursor string no Opaque per-venue cursor; resumes discovery over both SUI and USDC pairs.
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: Get transaction history
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true

(Recommended for wallet activity) Read a wallet’s decoded protocols, actions and coin flows; prefer this to query_transactions for exploring activity. from/to bound the chain query: ISO times are inclusive, checkpoint numbers exclusive. Rows use complete balance changes and commands. Newest first by default; oldest starts at the first transaction in the window. Pass next_cursor as cursor with the same from, to and order. address_poisoning always checks the shown page only, so empty pairs clear nothing older. subject_flow is the queried wallet’s signed change per coin; token_flow is the sender’s, omitted when they are the same address. Counterparties include at most 25 value recipients; counterparty_count reports larger sets. Summary keeps ~35k characters, preserving failed and lookalike-involved rows; omitted reports the rest and detail:‘full’ lists the whole page. signed_as_alias separately lists transactions signed as another wallet’s address_alias delegate, which the main page cannot show. The delegate scan is cached for up to five minutes; alias_scan_as_of dates it and signed_as_alias_unavailable marks incomplete scans, even beside returned matches.

Parameter Type Required Description
address string yes Sui wallet address (0x…)
from string no Inclusive window start as ISO 8601 time or exclusive after-checkpoint number.
to string no Inclusive window end as ISO 8601 time, ‘now’, or exclusive before-checkpoint number.
limit number (1 to 50), default 10 no Number of transactions to return (default 10, max 50)
order newest | oldest no ‘newest’ (default) pages backward from recent activity; ‘oldest’ pages forward from the first transaction.
cursor string no next_cursor from the previous page. Continues in the same direction; pass the same order, from and to.
detail summary | full no ‘summary’ (default) keeps ~35k chars in page order, always retaining failed and lookalike-involved rows; omitted reports the rest. ‘full’ lists every row of the page.
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: Get wallet overview
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true

(Recommended first tool for wallets) Overview of a Sui wallet: every coin balance, SuiNS name, staked SUI and kiosk counts, 50 newest transactions with an older-history continuation, and a time-bounded scan of package versions it published or upgraded in the first 20 sent transactions (package_activity.scan.next_call continues; package_activity_next_call retries if unavailable). include_prices adds USD values, coins ranked by value, and DeFi positions (staked SUI with rewards, liquid staking, liquidity, lending, and balances inside owned objects), each totalled apart. coverage says which owned objects the total covers and lists unrecognised types with counts; leads names lending positions near their borrow limit and shared vaults the wallet operates, with what they hold. include_nfts adds NFT estimates, kept out of the total.

Parameter Type Required Description
address string yes Wallet address (0x…)
include_prices boolean no Add USD values, DeFi positions, coverage and leads (default: false).
include_nfts boolean no With include_prices, also estimate held NFTs (default: false). Takes many requests on a wallet with many objects; list_nft_collections does this alone.
balance_cursor string no Opaque balance cursor from holdings_next_call. Returns the next bounded block of coin types; totals cover only this block.
owned_max_scan integer (1 to 50000) no Raise owned-object and position scan bounds for include_prices (defaults vary by reader); unread still reports any incomplete read.
nft_max_collections integer (1 to 5000) no NFT collection types valued with include_nfts (default 100); raise through nft_scan_next_call.
nft_market_depth integer (1 to 20) no Multiplier for bounded NFT market listing/sale reads (default 1); raise through nft_market_next_call.
operated_recent_limit integer (1 to 50) no Sent transactions per operated-shared-object scan page (default 20).
operated_candidate_limit integer (1 to 500) no Shared objects checked per operated scan page (default 20).
operated_cursor string no Older sent-transaction cursor from operated_scan.next_call.
detail summary | full no ‘summary’ (default): holdings and unrecognised object types that fit about 12k characters each, the rest in omitted. ‘full’: every row.
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: Get wallet packages
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true

List package versions created by publish or upgrade transactions sent from this wallet address. Scans 20 sent transactions per call, oldest first; scan.complete is true only when all pages and transactions were read. scan.next_call continues with an opaque cursor that carries prior unread counts. scan.incomplete_transactions names unread digests on this page and scan.prior_incomplete_transactions counts them on earlier pages. Each package carries its creating transaction, lineage root and version; an alias may have signed for the sender, and the sender is not necessarily the current UpgradeCap holder.

Parameter Type Required Description
address string yes Wallet address (0x…)
cursor string no Opaque cursor from scan.next_call, to scan the next 20 sent transactions.
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: Identify address
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true

(Recommended first step) Classify a Sui address as wallet, package, validator or object before choosing other tools. For wallets, package_activity scans the first 20 sent transactions for publishes/upgrades and provides next_call to continue; the result also includes balance and name context. Package results include modules and bridge labels on defined objects; bridge_carrier identifies bytecode calls into curated bridge exits. Validator results include stake information. A wallet’s first_seen is the oldest transaction GraphQL returns where it sent or was affected, with received coins read across all balance-change pages. first_inflow means it gained coins without sending, including genesis with sender:null; genesis names no funding wallet. Incomplete balance changes with no observed gain leave first_inflow null. first_seen_unavailable marks a failed first read. Use find_funding_sources when the first transaction was only a token airdrop.

Parameter Type Required Description
address string yes Sui address or object ID (0x…)
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’