Skip to content

Objects

Tool Summary
get_object Get a Sui object by its ID.
list_dynamic_fields List dynamic fields of a Sui object.
list_objects_by_type Scan current top-level Sui objects matching a Move struct or module filter across every owner kind.
list_owned_objects List raw objects owned by a Sui address with optional type filter and pagination.
  • Title: Get object
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true
  • Metadata: anthropic/maxResultSizeChars: 500000

Get a Sui object by its ID. Returns type, owner, version, content (JSON), and digest. Automatically extracts display metadata (name, description, image_url) for NFTs. For the LATEST version it also lists address_balances (funds the object holds in its own address balance, which are not among its fields and which only its defining module can withdraw) and, for a kiosk, kiosk_cap_holder: who actually controls it today, since content.owner is self-declared and not kept in sync with the KioskOwnerCap transfer that does. Neither is read for a specific version: both are current state and would misname a past snapshot’s controller.

Parameter Type Required Description
object_id string yes The object ID (0x…)
version string no Specific version to fetch
balance_cursor string no Continue the object’s bounded address-balance list from address_balances_next_call (latest object version only).
kiosk_scan_pages integer (1 to 2000) no Max pages of a kiosk creation or wrapper transaction to inspect for its owner cap (default 40, max 2000).
kiosk_wrap_steps integer (1 to 32) no Max nested wrapper/move steps followed for a kiosk owner cap (default 4, max 32).
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: List dynamic fields
  • Profile: developer
  • Annotations: openWorldHint: true, readOnlyHint: true

(Developer) List dynamic fields of a Sui object. Returns field names, types, and values. Useful for inspecting on-chain tables, kiosk contents, or other dynamic collections.

Parameter Type Required Description
parent_id string yes Parent object ID (0x…)
limit integer (1 to 1000) no Max results (default 50, max 1000)
cursor string no Pagination cursor from previous response
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: List objects by type
  • Profile: forensics
  • Annotations: openWorldHint: true, readOnlyHint: true
  • Metadata: anthropic/maxResultSizeChars: 500000

Scan current top-level Sui objects matching a Move struct or module filter across every owner kind. Objects wrapped inside another object’s fields are not indexed by type and are not listed. Reports scanned and matched counts, owner kinds, integer sums/min/max over selected fields, and the largest rows. where: {field:'offer',gt:'0'} keeps funded objects only. Nested paths use dots. A total is given only when every amount is in one unit: a Balance<T> field adds up per coin T with its decimals, any other field per object type; mixed units are listed in sum_units. Types are rewritten to the package versions that defined them; a module or struct the package lacks is refused with the names it has. A partial scan reports truncated and, when a cursor is available, next_call; totals cover only the objects this call scanned and are not cumulative across calls. Object-id order is unrelated to value. detail:'full' pages rows with row_offset, which scans again.

Parameter Type Required Description
type string yes Move struct type or module, e.g. 0x2::kiosk::Kiosk, 0x2::coin::Coin<0x2::sui::SUI> or 0x2::kiosk
sum_fields array of string (at most 8 items) no Numeric field paths to sum, e.g. [‘offer’] or [‘balance.value’]
where object no Include only objects with the named numeric field greater than gt (default ‘0’)
max_scan integer (1 to 50000) no Max objects to scan per call (default 10000, max 50000)
cursor string no Continue at next_cursor; sums and counts cover this call only
row_offset integer (0 to 50000) no Offset into value-ranked rows of this scan, for full-view pagination; each page scans again
detail summary | full no ‘full’ returns all rows scanned; summary caps rows but keeps totals
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’
  • Title: List owned objects
  • Profile: core (default)
  • Annotations: openWorldHint: true, readOnlyHint: true

List raw objects owned by a Sui address with optional type filter and pagination. count covers every object of the page; the default view lists the objects that fit about 30k characters in page order and states the rest under omitted, and detail: 'full' lists the whole page. next_cursor continues after the whole page, rows under omitted included. For NFTs specifically, prefer list_nfts (resolves kiosk storage, extracts display metadata). For a wallet summary, prefer get_wallet_overview.

Parameter Type Required Description
owner string no Owner address (0x…). Required; address is accepted in its place.
address string no Alias for owner.
object_type string no Filter by object type (e.g. 0x2::coin::Coin<0x2::sui::SUI>)
limit integer (1 to 1000) no Max results (default 50, max 1000)
cursor string no Pagination cursor from previous response
detail summary | full no ‘summary’ (default): the page’s objects that fit about 30k characters, the rest in omitted. ‘full’: the whole page.
network mainnet | testnet | devnet no Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’