sui Node API - suix_getAllCoins
v1.0.0https://sui.nownodes.ioReturns all Coin objects owned by a given sui address, supporting pagination with optional cursor and limit parameters.
Authentication
ApiKeyAuthapiKeyAPI Key: api-key in header
api-keyAuthapiKeyAPI Key: api-key in header
apiKeyapiKeyAPI Key: api-key in header
Coin Query API
suixGetAllCoins
Get all coins for an sui address
Returns all coin objects owned by the specified sui address. Supports pagination via cursor and limit.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | string | integer>requiredParameters array containing the owner address, optional cursor, and optional limit.
idintegerrequiredResponse
Successful response returning a page of coins.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve coins.
Authorization
ApiKeyAuthapiKey in headersuixGetAllBalances
Get total coin balances for an sui address
This method returns the total coin balance for all coin types owned by a given sui address.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters array containing the owner’s sui address.
idintegerrequiredResponse
Successful response with total balances for all coin types.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve balances.
Authorization
ApiKeyAuthapiKey in headersuixGetBalance
Get total balance of a specific coin type for an sui address
Returns the total balance for a specified coin type for the given sui address. Defaults to 0x2::sui::sui if coin_type is not provided.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | string>requiredArray containing the owner address and optional coin type.
idintegerrequiredResponse
Successful response returning the balance.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve balance.
Authorization
ApiKeyAuthapiKey in headersuixGetCoinMetadata
Get coin metadata
Returns metadata (symbol, decimals, description, icon, and object ID) for the specified coin type.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredArray with one coin type string
idintegerrequiredResponse
Successful response returning coin metadata.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve coin metadata.
Authorization
ApiKeyAuthapiKey in headersuixGetCoins
Get coins for an address
Returns all Coin objects owned by an address. Supports pagination via cursor and limit, and optional filtering by coin type.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | integer>requiredArray with the following parameters: 1. owner address (string, required) 2. coin type (string, optional) 3. cursor (string, optional) 4. limit (integer, optional)
idintegerrequiredResponse
Successful response returning a paginated list of Coin objects.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve coins.
Authorization
ApiKeyAuthapiKey in headersuixGetTotalSupply
Get total supply of a coin
Returns the total supply for the specified coin type. Default is sui if coin_type is not specified.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredArray with one string the coin type
idintegerrequiredResponse
Successful response returning the total supply for the coin.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve total supply.
Authorization
ApiKeyAuthapiKey in headerDiscover
Discover
Main entry point for all Sui JSON-RPC methods.
Body
jsonrpcstring2.0requiredJSON-RPC protocol version
methodstringrequiredName of the RPC method to call
paramsarrayParameters for the method (may be empty)
idintegerrequiredRequest identifier (can be any JSON value, typically a number)
Response
Successful RPC response
Authorization
api-keyAuthapiKey in headerExterned API
suixGetDynamicFieldObject
Get dynamic field object
Returns information about a dynamic field object given a parent object ID and field name.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | object>requiredArray with parent object ID and dynamic field name
idintegerrequiredResponse
Successful response returning the dynamic field object information.
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve dynamic field object.
Authorization
ApiKeyAuthapiKey in headersuix_getDynamicFields
Get Dynamic Fields
Return the list of dynamic field objects owned by an object
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getDynamicFieldsrequiredparamsArray<string | string | integer>requiredResponse
Successful response returning dynamic field objects
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuixGetOwnedObjects
Get objects owned by an address
Returns all objects owned by the specified sui address, with optional filtering and pagination.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | object>requiredidintegerrequiredResponse
Successful response returning dynamic fields
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve owned objects.
Authorization
ApiKeyAuthapiKey in headersuixQueryEvents
Query events with optional filters
Returns a list of events for the specified query criteria, supporting pagination and ordering.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object | object | integer | boolean>requiredidintegerrequiredResponse
Successful response returning a paginated list of events
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve events.
Authorization
ApiKeyAuthapiKey in headersuixQueryTransactionBlocks
Query transaction blocks with optional filters
Returns a list of transaction digests for the specified query criteria, supporting pagination and ordering.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object | string | integer | boolean>requiredidintegerrequiredResponse
Successful response returning a paginated list of transaction digests
Bad Request — Invalid parameters.
Unauthorized — Missing or invalid API key.
Internal Server Error — Could not retrieve transaction blocks.
Authorization
ApiKeyAuthapiKey in headersuix_resolveNameServiceAddress
Resolve Name Service Address
Returns the resolved address for the provided domain name
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_resolveNameServiceAddressrequiredparamsArray<string>requiredResponse
Successful response returning resolved address for the domain name
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuix_resolveNameServiceNames
Resolve Name Service Names
Return the resolved names given address, if multiple names are resolved, the first one is the primary name
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_resolveNameServiceNamesrequiredparamsArray<string | string | integer>requiredResponse
Successful response returning resolved names for the address
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headerGovernance Read API
suix_getCommitteeInfo
Get Committee Info
Return the committee information for the asked epoch
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getCommitteeInforequiredparamsArray<string>requiredResponse
Successful response returning committee information
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuix_getLatestSuiSystemState
Get Latest Sui System State
Return the latest SUI system state object on-chain
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getLatestSuiSystemStaterequiredparamsarrayrequiredNo parameters required for this method
Response
Successful response returning the latest SUI system state
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuix_getReferenceGasPrice
Get Reference Gas Price
Return the reference gas price for the network
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getReferenceGasPricerequiredparamsarrayrequiredNo parameters required for this method
Response
Successful response returning the reference gas price
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuix_getStakesByIds
Get Stakes By IDs
Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getStakesByIdsrequiredparamsArray<Array<string>>requiredResponse
Successful response returning delegated stakes by IDs
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuix_getStakes
Get Stakes
Return all [DelegatedStake] for an address
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getStakesrequiredparamsArray<string>requiredResponse
Successful response returning all delegated stakes
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersuix_getValidatorsApy
Get Validators APY
Return the validator APY
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsuix_getValidatorsApyrequiredparamsarrayrequiredNo parameters required for this method
Response
Successful response returning validator APYs
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headerMove Utils
sui_getMoveFunctionArgTypes
Get Move Function Argument Types
Returns the argument types for the package and function the request provides.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getMoveFunctionArgTypesrequiredparamsArray<any>requiredResponse
Successful response returning Move function argument types
Bad request - invalid parameters
Internal server error
Authorization
apiKeyapiKey in headersui_getNormalizedMoveFunction
Get normalized Move function
Returns a structured representation of the specified Move function in a package.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Normalized representation of the Move function
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getNormalizedMoveModule
Get Normalized Move Module
Return a structured representation of Move module
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getNormalizedMoveModulerequiredparamsArray<any>requiredResponse
Successful response returning normalized Move module
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
sui_getNormalizedMoveModulesByPackage
Get Normalized Move Modules By Package
Return structured representations of all modules in the given package
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getNormalizedMoveModulesByPackagerequiredparamsArray<string>requiredResponse
Successful response returning normalized Move modules
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
sui_getNormalizedMoveStruct
Get normalized Move struct
Returns a structured representation of a Move struct for the specified package, module, and struct name.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Normalized Move struct representation
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerRead API
sui_getChainIdentifier
Get chain identifier
Returns the first four bytes of the chain's genesis checkpoint digest.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<any>requiredidintegerrequiredResponse
Chain identifier (first 4 bytes of genesis checkpoint digest)
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getCheckpoint
Get checkpoint
Returns the checkpoint for a given checkpoint digest or sequence number.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Checkpoint information for the given ID
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getCheckpoints
Get Checkpoints
Return paginated list of checkpoints
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getCheckpointsrequiredparamsArray<string | integer | boolean>requiredResponse
Successful response returning paginated checkpoints
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getEvents
Get Events
Return transaction events
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getEventsrequiredparamsArray<string>requiredResponse
Successful response returning transaction events
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getLatestCheckpointSequenceNumber
Get Latest Checkpoint Sequence Number
Return the sequence number of the latest checkpoint that has been executed
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getLatestCheckpointSequenceNumberrequiredparamsarrayrequiredNo parameters required for this method
Response
Successful response returning the latest checkpoint sequence number
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getLoadedChildObjects
Get Loaded Child Objects
Gets loaded child objects associated with the transaction the request provides.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getLoadedChildObjectsrequiredparamsArray<string>requiredResponse
Successful response returning loaded child objects
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getObject
Get Object
Return the object information for a specified object
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getObjectrequiredparamsArray<any>requiredResponse
Successful response returning object information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerGet Object
Return the object information for a specified object
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getObjectrequiredparamsArray<any>requiredResponse
Successful response returning object information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_getProtocolConfig
Get Protocol Config
Return the protocol config table for the given version number. If the version number is not specified, the node uses the version of the latest epoch it has processed.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_getProtocolConfigrequiredparamsArray<integer>requiredResponse
Successful response returning protocol configuration
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_tryGetPastObject
Try Get Past Object
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. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_tryGetPastObjectrequiredparamsArray<any>requiredResponse
Successful response returning past object information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_tryMultiGetPastObjects
Try Multi Get Past Objects
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. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_tryMultiGetPastObjectsrequiredparamsArray<any>requiredResponse
Successful response returning multiple past object information
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headerWrite API
sui_devInspectTransactionBlock
Dev Inspect Transaction Block
Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_devInspectTransactionBlockrequiredparamsArray<any>requiredResponse
Successful response returning dev inspection results
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_dryRunTransactionBlock
Dry Run Transaction Block
Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_dryRunTransactionBlockrequiredparamsArray<string>requiredResponse
Successful response returning dry run transaction results
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in headersui_executeTransactionBlock
Execute Transaction Block
Execute the transaction and wait for results if desired. Request types:
- WaitForEffectsCert: waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality.
- WaitForLocalExecution: waits for TransactionEffectsCert and make sure the node executed the transaction locally before returning the client. The local execution makes sure this node is aware of this transaction when client fires subsequent queries. However if the node fails to execute the transaction locally in a timely manner, a bool type in the response is set to false to indicated the case. request_type is default to be WaitForEffectsCert unless options.show_events or options.show_effects is true
Body
jsonrpcstring2.0requiredidintegerrequiredmethodstringsui_executeTransactionBlockrequiredparamsArray<any>requiredResponse
Successful response returning executed transaction results
Bad Request
Unauthorized — Missing or invalid API key
Internal Server Error
Authorization
ApiKeyAuthapiKey in header