Home

sui Node API - suix_getAllCoins

v1.0.0
Base URL
https://sui.nownodes.io

Returns all Coin objects owned by a given sui address, supporting pagination with optional cursor and limit parameters.

Authentication

ApiKeyAuthapiKey

API Key: api-key in header

api-keyAuthapiKey

API Key: api-key in header

apiKeyapiKey

API Key: api-key in header

Coin Query API

suixGetAllCoins

Get all coins for an sui address

POST
https://sui.nownodes.io/

Returns all coin objects owned by the specified sui address. Supports pagination via cursor and limit.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string | string | integer>required

Parameters array containing the owner address, optional cursor, and optional limit.

Show child attributes
One of

sui address of the coin owner.

string

Optional paging cursor.

string

Optional limit of items per page.

integer
idintegerrequired

Response

200OK

Successful response returning a page of coins.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve coins.

Authorization

ApiKeyAuthapiKey in header

suixGetAllBalances

Get total coin balances for an sui address

POST
https://sui.nownodes.io/

This method returns the total coin balance for all coin types owned by a given sui address.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string>required

Parameters array containing the owner’s sui address.

idintegerrequired

Response

200OK

Successful response with total balances for all coin types.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve balances.

Authorization

ApiKeyAuthapiKey in header

suixGetBalance

Get total balance of a specific coin type for an sui address

POST
https://sui.nownodes.io/

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

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string | string>required

Array containing the owner address and optional coin type.

Show child attributes
One of

sui address of the owner.

string

Optional coin type. Defaults to 0x2::sui::sui.

string
idintegerrequired

Response

200OK

Successful response returning the balance.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve balance.

Authorization

ApiKeyAuthapiKey in header

suixGetCoinMetadata

Get coin metadata

POST
https://sui.nownodes.io/

Returns metadata (symbol, decimals, description, icon, and object ID) for the specified coin type.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string>required

Array with one coin type string

idintegerrequired

Response

200OK

Successful response returning coin metadata.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve coin metadata.

Authorization

ApiKeyAuthapiKey in header

suixGetCoins

Get coins for an address

POST
https://sui.nownodes.io/

Returns all Coin objects owned by an address. Supports pagination via cursor and limit, and optional filtering by coin type.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string | integer>required

Array with the following parameters: 1. owner address (string, required) 2. coin type (string, optional) 3. cursor (string, optional) 4. limit (integer, optional)

Show child attributes
One of
string
integer
idintegerrequired

Response

200OK

Successful response returning a paginated list of Coin objects.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve coins.

Authorization

ApiKeyAuthapiKey in header

suixGetTotalSupply

Get total supply of a coin

POST
https://sui.nownodes.io/

Returns the total supply for the specified coin type. Default is sui if coin_type is not specified.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string>required

Array with one string the coin type

idintegerrequired

Response

200OK

Successful response returning the total supply for the coin.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve total supply.

Authorization

ApiKeyAuthapiKey in header

Discover

Discover

POST
https://sui.nownodes.io/

Main entry point for all Sui JSON-RPC methods.

Body

application/json
jsonrpcstring2.0required

JSON-RPC protocol version

methodstringrequired

Name of the RPC method to call

paramsarray

Parameters for the method (may be empty)

idintegerrequired

Request identifier (can be any JSON value, typically a number)

Response

200OK

Successful RPC response

Authorization

api-keyAuthapiKey in header

Externed API

suixGetDynamicFieldObject

Get dynamic field object

POST
https://sui.nownodes.io/

Returns information about a dynamic field object given a parent object ID and field name.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string | object>required

Array with parent object ID and dynamic field name

Show child attributes
One of

Parent object ID

string
typestring
valuestring
idintegerrequired

Response

200OK

Successful response returning the dynamic field object information.

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve dynamic field object.

Authorization

ApiKeyAuthapiKey in header

suix_getDynamicFields

Get Dynamic Fields

POST
https://sui.nownodes.io/

Return the list of dynamic field objects owned by an object

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getDynamicFieldsrequired
paramsArray<string | string | integer>required
Show child attributes
One of

Object ID to get dynamic fields for

string

Cursor for pagination (optional)

string

Limit of results per page (optional)

integer

Response

200OK

Successful response returning dynamic field objects

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suixGetOwnedObjects

Get objects owned by an address

POST
https://sui.nownodes.io/

Returns all objects owned by the specified sui address, with optional filtering and pagination.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string | object>required
Show child attributes
One of

Owner sui address or cursor

string

Optional filter and options

object
idintegerrequired

Response

200OK

Successful response returning dynamic fields

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve owned objects.

Authorization

ApiKeyAuthapiKey in header

suixQueryEvents

Query events with optional filters

POST
https://sui.nownodes.io/

Returns a list of events for the specified query criteria, supporting pagination and ordering.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<object | object | integer | boolean>required
Show child attributes
One of

Query criteria

object

Cursor for pagination

object

Maximum number of items per page

integer

Descending order flag

boolean
idintegerrequired

Response

200OK

Successful response returning a paginated list of events

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve events.

Authorization

ApiKeyAuthapiKey in header

suixQueryTransactionBlocks

Query transaction blocks with optional filters

POST
https://sui.nownodes.io/

Returns a list of transaction digests for the specified query criteria, supporting pagination and ordering.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<object | string | integer | boolean>required
Show child attributes
One of

Query criteria

object

Cursor for pagination

string

Maximum number of items per page

integer

Descending order flag

boolean
idintegerrequired

Response

200OK

Successful response returning a paginated list of transaction digests

400Bad Request

Bad Request — Invalid parameters.

401Unauthorized

Unauthorized — Missing or invalid API key.

500Internal Server Error

Internal Server Error — Could not retrieve transaction blocks.

Authorization

ApiKeyAuthapiKey in header

suix_resolveNameServiceAddress

Resolve Name Service Address

POST
https://sui.nownodes.io/

Returns the resolved address for the provided domain name

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_resolveNameServiceAddressrequired
paramsArray<string>required

Response

200OK

Successful response returning resolved address for the domain name

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suix_resolveNameServiceNames

Resolve Name Service Names

POST
https://sui.nownodes.io/

Return the resolved names given address, if multiple names are resolved, the first one is the primary name

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_resolveNameServiceNamesrequired
paramsArray<string | string | integer>required
Show child attributes
One of

Address to resolve names for

string

Cursor for pagination (optional)

string

Limit of results per page (optional)

integer

Response

200OK

Successful response returning resolved names for the address

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

Governance Read API

suix_getCommitteeInfo

Get Committee Info

POST
https://sui.nownodes.io/

Return the committee information for the asked epoch

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getCommitteeInforequired
paramsArray<string>required

Response

200OK

Successful response returning committee information

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suix_getLatestSuiSystemState

Get Latest Sui System State

POST
https://sui.nownodes.io/

Return the latest SUI system state object on-chain

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getLatestSuiSystemStaterequired
paramsarrayrequired

No parameters required for this method

Response

200OK

Successful response returning the latest SUI system state

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suix_getReferenceGasPrice

Get Reference Gas Price

POST
https://sui.nownodes.io/

Return the reference gas price for the network

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getReferenceGasPricerequired
paramsarrayrequired

No parameters required for this method

Response

200OK

Successful response returning the reference gas price

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suix_getStakesByIds

Get Stakes By IDs

POST
https://sui.nownodes.io/

Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getStakesByIdsrequired
paramsArray<Array<string>>required

Response

200OK

Successful response returning delegated stakes by IDs

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suix_getStakes

Get Stakes

POST
https://sui.nownodes.io/

Return all [DelegatedStake] for an address

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getStakesrequired
paramsArray<string>required

Response

200OK

Successful response returning all delegated stakes

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

suix_getValidatorsApy

Get Validators APY

POST
https://sui.nownodes.io/

Return the validator APY

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsuix_getValidatorsApyrequired
paramsarrayrequired

No parameters required for this method

Response

200OK

Successful response returning validator APYs

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

Move Utils

sui_getMoveFunctionArgTypes

Get Move Function Argument Types

POST
https://sui.nownodes.io/

Returns the argument types for the package and function the request provides.

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getMoveFunctionArgTypesrequired
paramsArray<any>required

Response

200OK

Successful response returning Move function argument types

400Bad Request

Bad request - invalid parameters

500Internal Server Error

Internal server error

Authorization

apiKeyapiKey in header

sui_getNormalizedMoveFunction

Get normalized Move function

POST
https://sui.nownodes.io/

Returns a structured representation of the specified Move function in a package.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string>required
idintegerrequired

Response

200OK

Normalized representation of the Move function

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getNormalizedMoveModule

Get Normalized Move Module

POST
https://sui.nownodes.io/

Return a structured representation of Move module

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getNormalizedMoveModulerequired
paramsArray<any>required

Response

200OK

Successful response returning normalized Move module

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

sui_getNormalizedMoveModulesByPackage

Get Normalized Move Modules By Package

POST
https://sui.nownodes.io/

Return structured representations of all modules in the given package

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getNormalizedMoveModulesByPackagerequired
paramsArray<string>required

Response

200OK

Successful response returning normalized Move modules

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

sui_getNormalizedMoveStruct

Get normalized Move struct

POST
https://sui.nownodes.io/

Returns a structured representation of a Move struct for the specified package, module, and struct name.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string>required
idintegerrequired

Response

200OK

Normalized Move struct representation

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

Read API

sui_getChainIdentifier

Get chain identifier

POST
https://sui.nownodes.io/

Returns the first four bytes of the chain's genesis checkpoint digest.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<any>required
idintegerrequired

Response

200OK

Chain identifier (first 4 bytes of genesis checkpoint digest)

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getCheckpoint

Get checkpoint

POST
https://sui.nownodes.io/

Returns the checkpoint for a given checkpoint digest or sequence number.

Body

application/json
jsonrpcstringrequired
methodstringrequired
paramsArray<string>required
idintegerrequired

Response

200OK

Checkpoint information for the given ID

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getCheckpoints

Get Checkpoints

POST
https://sui.nownodes.io/

Return paginated list of checkpoints

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getCheckpointsrequired
paramsArray<string | integer | boolean>required
Show child attributes
One of

Starting checkpoint sequence number (optional)

string

Limit of results per page (optional)

integer

Whether to return transactions in the checkpoint (optional)

boolean

Response

200OK

Successful response returning paginated checkpoints

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getEvents

Get Events

POST
https://sui.nownodes.io/

Return transaction events

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getEventsrequired
paramsArray<string>required

Response

200OK

Successful response returning transaction events

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getLatestCheckpointSequenceNumber

Get Latest Checkpoint Sequence Number

POST
https://sui.nownodes.io/

Return the sequence number of the latest checkpoint that has been executed

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getLatestCheckpointSequenceNumberrequired
paramsarrayrequired

No parameters required for this method

Response

200OK

Successful response returning the latest checkpoint sequence number

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getLoadedChildObjects

Get Loaded Child Objects

POST
https://sui.nownodes.io/

Gets loaded child objects associated with the transaction the request provides.

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getLoadedChildObjectsrequired
paramsArray<string>required

Response

200OK

Successful response returning loaded child objects

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getObject

Get Object

POST
https://sui.nownodes.io/

Return the object information for a specified object

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getObjectrequired
paramsArray<any>required

Response

200OK

Successful response returning object information

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

Get Object

POST
https://sui.nownodes.io/

Return the object information for a specified object

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getObjectrequired
paramsArray<any>required

Response

200OK

Successful response returning object information

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_getProtocolConfig

Get Protocol Config

POST
https://sui.nownodes.io/

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

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_getProtocolConfigrequired
paramsArray<integer>required

Response

200OK

Successful response returning protocol configuration

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_tryGetPastObject

Try Get Past Object

POST
https://sui.nownodes.io/

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

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_tryGetPastObjectrequired
paramsArray<any>required

Response

200OK

Successful response returning past object information

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_tryMultiGetPastObjects

Try Multi Get Past Objects

POST
https://sui.nownodes.io/

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

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_tryMultiGetPastObjectsrequired
paramsArray<any>required

Response

200OK

Successful response returning multiple past object information

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

Write API

sui_devInspectTransactionBlock

Dev Inspect Transaction Block

POST
https://sui.nownodes.io/

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

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_devInspectTransactionBlockrequired
paramsArray<any>required

Response

200OK

Successful response returning dev inspection results

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_dryRunTransactionBlock

Dry Run Transaction Block

POST
https://sui.nownodes.io/

Return transaction execution effects including the gas cost summary, while the effects are not committed to the chain.

Body

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_dryRunTransactionBlockrequired
paramsArray<string>required

Response

200OK

Successful response returning dry run transaction results

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header

sui_executeTransactionBlock

Execute Transaction Block

POST
https://sui.nownodes.io/

Execute the transaction and wait for results if desired. Request types:

  1. WaitForEffectsCert: waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality.
  2. 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

application/json
jsonrpcstring2.0required
idintegerrequired
methodstringsui_executeTransactionBlockrequired
paramsArray<any>required

Response

200OK

Successful response returning executed transaction results

400Bad Request

Bad Request

401Unauthorized

Unauthorized — Missing or invalid API key

500Internal Server Error

Internal Server Error

Authorization

ApiKeyAuthapiKey in header