Skip to main content
The ReadApi provides read-only access to Sui network data. All methods are in the sui namespace.

​
Methods

​
getTransactionBlock

Returns transaction details by digest.
​
digest
TransactionDigest
required
The digest of the queried transaction
​
options
SuiTransactionBlockResponseOptions
Options for specifying the content to be returned
​
result
SuiTransactionBlockResponse
The transaction response object
curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_getTransactionBlock",
    "params": [
      "7nPJKfZTx2YWqZWW3A8cXnFQVFQs7FKqBZqXU6qz5K4Q",
      {
        "showInput": true,
        "showEffects": true,
        "showEvents": true
      }
    ]
  }'

​
multiGetTransactionBlocks

Returns an ordered list of transaction responses. Throws an error if input contains duplicates or exceeds QUERY_MAX_RESULT_LIMIT.
​
digests
TransactionDigest[]
required
A list of transaction digests
​
options
SuiTransactionBlockResponseOptions
Config options to control which fields to fetch
​
result
SuiTransactionBlockResponse[]
Array of transaction response objects

​
getObject

Returns object information for a specified object.
​
object_id
ObjectID
required
The ID of the queried object
​
options
SuiObjectDataOptions
Options for specifying the content to be returned
​
result
SuiObjectResponse
The object information
curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_getObject",
    "params": [
      "0x5",
      {
        "showType": true,
        "showOwner": true,
        "showContent": true
      }
    ]
  }'

​
multiGetObjects

Returns object data for a list of objects.
​
object_ids
ObjectID[]
required
The IDs of the queried objects
​
options
SuiObjectDataOptions
Options for specifying the content to be returned
​
result
SuiObjectResponse[]
Array of object responses

​
tryGetPastObject

Returns object information for a specified version. No software-level guarantee that past objects can be retrieved.
​
object_id
ObjectID
required
The ID of the queried object
​
version
SequenceNumber
required
The version of the queried object
​
options
SuiObjectDataOptions
Options for specifying the content to be returned
​
result
SuiPastObjectResponse
The past object information

​
tryMultiGetPastObjects

Returns object information for a list of past objects.
​
past_objects
SuiGetPastObjectRequest[]
required
A vector of object and versions to be queried
​
options
SuiObjectDataOptions
Options for specifying the content to be returned
​
result
SuiPastObjectResponse[]
Array of past object responses

​
getCheckpoint

Returns a checkpoint by sequence number or digest.
​
id
CheckpointId
required
Checkpoint identifier (digest or sequence number)
​
result
Checkpoint
The checkpoint data
curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_getCheckpoint",
    "params": ["1000000"]
  }'

​
getCheckpoints

Returns a paginated list of checkpoints.
​
cursor
BigInt<u64>
Optional paging cursor. If provided, query starts from the next item after the cursor
​
limit
usize
Maximum items returned per page
​
descending_order
boolean
required
Query result ordering (false = ascending, oldest first)
​
result
CheckpointPage
Paginated checkpoint results

​
getEvents

Returns transaction events by transaction digest.
​
transaction_digest
TransactionDigest
required
The event query criteria
​
result
SuiEvent[]
Array of events emitted by the transaction

​
getTotalTransactionBlocks

Returns the total number of transaction blocks known to the server.
​
result
BigInt<u64>
Total transaction count
curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_getTotalTransactionBlocks",
    "params": []
  }'

​
getLatestCheckpointSequenceNumber

Returns the sequence number of the latest checkpoint that has been executed.
​
result
BigInt<u64>
Latest checkpoint sequence number

​
getProtocolConfig

Returns the protocol config table for the given version number. If no version is specified, returns the latest protocol config.
​
version
BigInt<u64>
Optional protocol version specifier
​
result
ProtocolConfigResponse
Protocol configuration parameters

​
getChainIdentifier

Returns the first four bytes of the chain’s genesis checkpoint digest.
​
result
string
Chain identifier string
curl -X POST https://fullnode.mainnet.sui.io:443 \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "sui_getChainIdentifier",
    "params": []
  }'

​
verifyZkLoginSignature

Verifies a zkLogin signature for the given bytes, intent scope, and author.
​
bytes
string
required
Base64 string of BCS bytes for raw transaction data or personal message
​
signature
string
required
Base64 string of the zkLogin signature to verify
​
intent_scope
ZkLoginIntentScope
required
Intent scope: either TransactionData or PersonalMessage
​
author
SuiAddress
required
The author of the signature
​
result
ZkLoginVerifyResult
Verification result

Build docs developers (and LLMs) love

Get started for freeTalk to us