Iota - JSON-RPC

JSON-RPC methods supported on Iota Mainnet, Iota Devnet and Iota Testnet through Tatum RPC Gateway, with base URLs and an example request.

Call Iota JSON-RPC methods through Tatum RPC Gateway. Send an HTTP POST request with a JSON-RPC 2.0 body to the network's base URL, with your API key in the x-api-key header. See Authentication.

Base URLs

NetworkBase URL
Iota Mainnethttps://iota-mainnet.gateway.tatum.io
Iota Devnethttps://iota-devnet.gateway.tatum.io
Iota Testnethttps://iota-testnet.gateway.tatum.io

Example request

curl 'https://iota-mainnet.gateway.tatum.io' \
  --header 'content-type: application/json' \
  --header 'x-api-key: {YOUR_API_KEY}' \
  --data '{"jsonrpc":"2.0","method":"iota_getLatestCheckpointSequenceNumber","params":[],"id":1}'

Methods

35 methods. Parameters and responses are described in the IOTA JSON-RPC API reference; linked method names go to their page there.

MethodDescription
iota_dryRunTransactionBlockSimulates a transaction and returns its effects and gas cost without committing it.
iota_executeTransactionBlockSubmits a signed transaction for execution and optionally waits for its effects.
iota_getChainIdentifierReturns the chain identifier, the first four bytes of the genesis checkpoint digest.
iota_getCheckpointReturns a checkpoint by sequence number or digest.
iota_getCheckpointsReturns a paginated list of checkpoints.
iota_getEventsReturns the events emitted by a transaction.
iota_getLatestCheckpointSequenceNumberReturns the sequence number of the latest executed checkpoint.
iota_getObjectReturns the data of an object by its ID.
iota_getProtocolConfigReturns the protocol configuration for a given version, or for the latest epoch.
iota_getTotalTransactionBlocksReturns the total number of transaction blocks known to the node.
iota_getTransactionBlockReturns a transaction by its digest.
iota_multiGetObjectsReturns the data of multiple objects by their IDs.
iota_multiGetTransactionBlocksReturns an ordered list of transactions by their digests.
iota_tryGetPastObjectReturns a past version of an object, if the node still has it.
iota_tryMultiGetPastObjectsReturns past versions of multiple objects, if the node still has them.
iotax_getAllBalancesReturns the total balance of every coin type owned by an address.
iotax_getAllCoinsReturns all coin objects owned by an address.
iotax_getBalanceReturns the total balance of one coin type owned by an address.
iotax_getCirculatingSupplyReturns the circulating supply summary.
iotax_getCoinMetadataReturns the metadata of a coin type, such as symbol and decimals.
iotax_getCoinsReturns the coin objects of a given coin type owned by an address.
iotax_getCommitteeInfoReturns the validator committee for a given epoch.
iotax_getDynamicFieldsReturns the dynamic fields owned by an object.
iotax_getLatestIotaSystemStateDeprecated. Use iotax_getLatestIotaSystemStateV2 instead.
iotax_getLatestIotaSystemStateV2Returns the latest IOTA system state object.
iotax_getReferenceGasPriceReturns the reference gas price for the network.
iotax_getStakesReturns all delegated stakes of an address.
iotax_getTotalSupplyReturns the total supply of a coin type.
iotax_iotaNamesFindAllRegistrationNFTsReturns all IOTA Names registration NFTs owned by an address.
iotax_iotaNamesLookupReturns the record that an IOTA name resolves to.
iotax_iotaNamesReverseLookupReturns the IOTA name that an address resolves to.
iotax_queryEventsReturns events that match a query filter.
iotax_queryTransactionBlocksReturns transactions that match a query filter.
iotax_subscribeEventSubscribes to events that match a filter. Requires a WebSocket connection.
iotax_subscribeTransactionSubscribes to transactions that match a filter. Requires a WebSocket connection.

The gateway lists its supported methods at runtime:

Method unavailable?

If you need a method we don't support yet, contact support.