JSON-RPC Methods

Every Sui JSON-RPC method that Inodra serves on mainnet and testnet. Send requests to https://mainnet-api.inodra.com/v1/jsonrpc or https://testnet-api.inodra.com/v1/jsonrpc with your API key in the x-api-key header. Setup and batches: JSON-RPC Gateway.

Subscriptions (suix_subscribeEvent, suix_subscribeTransaction) are not served. Use Warp streams for real-time data. The full OpenRPC document is available for code generation. On testnet, transaction and event search covers about the last 80 days (details).

Read API

Method	Description
sui_getChainIdentifier	Return the first four bytes of the chain's genesis checkpoint digest.
sui_getCheckpoint	Return a checkpoint
sui_getCheckpoints	Return paginated list of checkpoints
sui_getEvents	Return transaction events.
sui_getLatestCheckpointSequenceNumber	Return the sequence number of the latest checkpoint that has been executed
sui_getObject	Return the object information for a specified object
sui_getProtocolConfig	Return the protocol config table for the given version number.
sui_getTotalTransactionBlocks	Return the total number of transaction blocks known to the server.
sui_getTransactionBlock	Return the transaction response object.
sui_multiGetObjects	Return the object data for a list of objects
sui_multiGetTransactionBlocks	Returns an ordered list of transaction responses The method will throw an error if the input contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT
sui_tryGetPastObject	Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed.
sui_tryMultiGetPastObjects	Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed.
sui_verifyZkLoginSignature	Verify a zklogin signature for the given bytes, intent scope and author.

Extended API

Method	Description
suix_getCurrentEpoch	Return current epoch info
suix_getDynamicFieldObject	Return the dynamic field object information for a specified object
suix_getDynamicFields	Return the list of dynamic field objects owned by an object.
suix_getEpochs	Return a list of epoch info
suix_getOwnedObjects	Return the list of objects owned by an address.
suix_getTotalTransactions
suix_queryEvents	Return list of events for a specified query criteria.
suix_queryObjects	Return the list of queried objects.
suix_queryTransactionBlocks	Return list of transactions for a specified query criteria.
suix_resolveNameServiceAddress	Return the resolved address given resolver and name
suix_resolveNameServiceNames	Return the resolved names given address, if multiple names are resolved, the first one is the primary name.

Coin Query API

Method	Description
suix_getAllBalances	Return the total coin balance for all coin type, owned by the address owner.
suix_getAllCoins	Return all Coin objects owned by an address.
suix_getBalance	Return the total coin balance for one coin type, owned by the address owner.
suix_getCoinMetadata	Return metadata (e.g., symbol, decimals) for a coin.
suix_getCoins	Return all Coin<coin_type> objects owned by an address.
suix_getTotalSupply	Return total supply for a coin

Governance Read API

Method	Description
suix_getCommitteeInfo	Return the committee information for the asked epoch.
suix_getLatestSuiSystemState	Return the latest SUI system state object on-chain.
suix_getReferenceGasPrice	Return the reference gas price for the network
suix_getStakes	Return all [DelegatedStake].
suix_getStakesByIds	Return one or more [DelegatedStake].
suix_getValidatorsApy	Return the validator APY

Move Utils

Method	Description
sui_getMoveFunctionArgTypes	Return the argument types of a Move function, based on normalized Type.
sui_getNormalizedMoveFunction	Return a structured representation of Move function
sui_getNormalizedMoveModule	Return a structured representation of Move module
sui_getNormalizedMoveModulesByPackage	Return structured representations of all modules in the given package
sui_getNormalizedMoveStruct	Return a structured representation of Move struct

Transaction Builder API

Method	Description
unsafe_batchTransaction	Create an unsigned batched transaction.
unsafe_mergeCoins	Create an unsigned transaction to merge multiple coins into one coin.
unsafe_moveCall	Create an unsigned transaction to execute a Move call on the network, by calling the specified function in the module of a given package.
unsafe_pay	Send Coin<T> to a list of addresses, where T can be any coin type, following a list of amounts, The object specified in the gas field will be used to pay the gas fee for the transaction.
unsafe_payAllSui	Send all SUI coins to one recipient.
unsafe_paySui	Send SUI coins to a list of addresses, following a list of amounts.
unsafe_publish	Create an unsigned transaction to publish a Move package.
unsafe_requestAddStake	Add stake to a validator's staking pool using multiple coins and amount.
unsafe_requestWithdrawStake	Withdraw stake from a validator's staking pool.
unsafe_splitCoin	Create an unsigned transaction to split a coin object into multiple coins.
unsafe_splitCoinEqual	Create an unsigned transaction to split a coin object into multiple equal-size coins.
unsafe_transferObject	Create an unsigned transaction to transfer an object from one address to another.
unsafe_transferSui	Create an unsigned transaction to send SUI coin object to a Sui address.

Write API

Method	Description
sui_devInspectTransactionBlock	Runs the transaction in dev-inspect mode.
sui_dryRunTransactionBlock	Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.
sui_executeTransactionBlock	Execute the transaction and wait for results if desired.

Bridge Read API

Method	Description
suix_getBridgeObjectInitialSharedVersion	Returns the initial shared version of the bridge object, usually for the purpose of constructing an ObjectArg in a transaction.
suix_getLatestBridge	Returns the latest BridgeSummary

Method descriptions and examples come from the Sui OpenRPC specification (Apache-2.0).