Umi API
Umi exposes a developer API through a TypeScript SDK that makes working with Containers simple. Under the hood, a Rust indexer tracks everything related to Containers and maintains fast, queryable state. The SDK lets you fetch container inventory, filter containers by what they contain, and build marketplace or discovery experiences without running your own indexing stack.
Umi is built to make integrating container-backed cross-chain assets feel seamless. You can rely on our indexing layer for efficiency, but containers should always be verified against what the underlying wallet actually holds.
What you can do with the SDK
Query a container
Fetch the full view of a container, including:
container metadata and ownership
current claims and claim types
verification state (based on the deposit and indexing lifecycle)
normalized asset identifiers (chain, standard, collection, token id)
optional metadata fields when available (name, image, traits)
Query containers by wallet address
You can fetch containers related to a specific wallet identity, such as:
all containers owned by a given Sui address
all containers associated with a specific external wallet address (when applicable)
containers linked to a specific Ika wallet identity
This enables portfolio pages, account pages, and “show me everything this wallet has listed” views.
Search containers by what they contain
The SDK supports discovery queries so you can find containers that match specific criteria, such as:
all containers containing a specific Solana collection
all containers containing a specific Ethereum collection
all containers containing a specific asset type (NFTs, bundles, accounts, roles, etc.)
Query by structure and intent
Because containers can represent different “shapes” of listings, you can search for containers like:
Single-item containers Containers that contain exactly 1 NFT (great for standard listings)
Bundle containers Containers that contain multiple NFTs (bundle listings)
Account containers Containers that represent an entire account for sale (account-level control, permissions, and wallet identity)
This makes it easy to build category pages, discovery feeds, search, and filters around containers instead of forcing every DApp to interpret raw on-chain data.
Verification (recommended)
Umi’s indexer and API are designed to reflect the real state of the underlying wallet. Containers are useful because they provide a stable anchor for indexing and verification.
Even so, DApps can always verify independently using their own chain RPCs/indexers. We recommend verifying independently for settlement, high-value actions, or any workflow with custom trust requirements.
Why use Umi instead of indexing yourself
Use the SDK if you want:
fast reads and discovery queries without operating your own indexer
normalized cross-chain identifiers and consistent container semantics
container-level filtering (single items, bundles, accounts for sale)
wallet-based queries for portfolio and listings views
an easy integration surface for container-based trading and inventory
Pricing
The API will be offered as a free service with paid options. Pricing is not finalized yet.
Last updated