Skip to main content
The Read API provides methods for querying blockchain data including transactions, objects, checkpoints, and protocol configuration.

​
iota_getTransactionBlock

Return the transaction response object for a given transaction digest.
​
digest
TransactionDigest
required
The digest of the queried transaction (Base58 encoded)
​
options
IotaTransactionBlockResponseOptions
Options for specifying the content to be returned
​
digest
TransactionDigest
The transaction digest
​
transaction
Transaction
The transaction data
​
effects
TransactionEffects
The effects of executing the transaction
​
checkpoint
BigInt<u64>
The checkpoint number when this transaction was finalized
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getTransactionBlock",
    "params": [
      "Dv5XRBjWvZTwiHVrhUetvDTgxyM8xVMb6P8pCAZv51tq",
      {
        "showInput": true,
        "showEffects": true,
        "showEvents": true
      }
    ]
  }'

​
iota_multiGetTransactionBlocks

Returns an ordered list of transaction responses for multiple transaction digests.
​
digests
Vec<TransactionDigest>
required
A list of transaction digests (maximum 50 per request)
​
options
IotaTransactionBlockResponseOptions
Config options to control which fields to fetch
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_multiGetTransactionBlocks",
    "params": [
      [
        "Dv5XRBjWvZTwiHVrhUetvDTgxyM8xVMb6P8pCAZv51tq",
        "8bXXsW9JQuYWXnLNhqnzQvzxiLHPFPH4fRLhbkdGVZza"
      ],
      {
        "showInput": true,
        "showEffects": true
      }
    ]
  }'

​
iota_getObject

Return the object information for a specified object ID.
​
object_id
ObjectID
required
The ID of the queried object (hex string prefixed with 0x)
​
options
IotaObjectDataOptions
Options for specifying the content to be returned
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getObject",
    "params": [
      "0x5",
      {
        "showType": true,
        "showOwner": true,
        "showContent": true
      }
    ]
  }'

​
iota_multiGetObjects

Return the object data for a list of objects.
​
object_ids
Vec<ObjectID>
required
The IDs of the queried objects
​
options
IotaObjectDataOptions
Options for specifying the content to be returned

​
iota_tryGetPastObject

Return the object information for a specified version. Note: There is no software-level guarantee that objects with past versions can be retrieved.
​
object_id
ObjectID
required
The ID of the queried object
​
version
SequenceNumber
required
The version of the queried object
​
options
IotaObjectDataOptions
Options for specifying the content to be returned

​
iota_getCheckpoint

Return a checkpoint by its sequence number or digest.
​
id
CheckpointId
required
Checkpoint identifier - can use either checkpoint digest or checkpoint sequence number as input
​
epoch
BigInt<u64>
Checkpoint’s epoch ID
​
sequenceNumber
BigInt<u64>
Checkpoint sequence number
​
digest
String
Checkpoint digest (Base58 encoded)
​
networkTotalTransactions
BigInt<u64>
Total number of transactions in the network by the end of this checkpoint
​
previousDigest
String
Digest of the previous checkpoint
​
timestampMs
BigInt<u64>
Timestamp of the checkpoint in milliseconds
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getCheckpoint",
    "params": ["1000"]
  }'

​
iota_getCheckpoints

Return a paginated list of checkpoints.
​
cursor
BigInt<u64>
An optional paging cursor. If provided, the query will start from the next item after the specified cursor
​
limit
usize
Maximum items returned per page (default: 50, max: 100)
​
descending_order
boolean
required
Query result ordering - false for ascending (oldest first), true for descending (newest first)
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getCheckpoints",
    "params": [null, 10, false]
  }'

​
iota_getEvents

Return transaction events for a given transaction digest.
​
transaction_digest
TransactionDigest
required
The transaction digest to query events for
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getEvents",
    "params": ["Dv5XRBjWvZTwiHVrhUetvDTgxyM8xVMb6P8pCAZv51tq"]
  }'

​
iota_getTotalTransactionBlocks

Return the total number of transaction blocks known to the server.
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getTotalTransactionBlocks",
    "params": []
  }'

​
iota_getLatestCheckpointSequenceNumber

Return the sequence number of the latest checkpoint that has been executed.
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getLatestCheckpointSequenceNumber",
    "params": []
  }'

​
iota_getProtocolConfig

Return the protocol config table for the given version number. If none is specified, the node uses the version of the latest epoch it has processed.
​
version
BigInt<u64>
An optional protocol version specifier. If omitted, the latest protocol config table will be returned
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getProtocolConfig",
    "params": []
  }'

​
iota_getChainIdentifier

Return the first four bytes of the chain’s genesis checkpoint digest.
​
result
String
The chain identifier string
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_getChainIdentifier",
    "params": []
  }'

​
iota_isTransactionIndexedOnNode

Return whether the transaction has been indexed on the fullnode.
​
digest
TransactionDigest
required
The digest of the queried transaction
cURL
curl -X POST https://api.iota.io \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "iota_isTransactionIndexedOnNode",
    "params": ["Dv5XRBjWvZTwiHVrhUetvDTgxyM8xVMb6P8pCAZv51tq"]
  }'

Build docs developers (and LLMs) love

Get started for freeTalk to us