For the complete documentation index, see llms.txt. This page is also available as Markdown.

IOTA

GetBlock provides fast and reliable access to IOTA nodes via JSON-RPC API. Connect to the IOTA network without running your own infrastructure.

IOTA is a Layer-1 network built on a Move-based, object-centric protocol (the IOTA Rebased architecture, a fork of the Sui stack).

State is modeled as typed objects owned by addresses, smart contracts are written in Move, and the native token is IOTA, denominated in NANOs (1 IOTA = 1,000,000,000 NANOs).

GetBlock exposes the IOTA node JSON-RPC API: a JSON-RPC 2.0 interface over HTTP whose methods live in the iota_ (core read/write and Move utilities), iotax_ (coin, extended indexer, and governance queries), and unsafe_ (server-side transaction building) namespaces.

Key Features

  • Move + Objects: State is typed Move objects owned by addresses, not account balances in a single trie

  • JSON-RPC 2.0: A single POST endpoint; the method and positional params array select the call

  • Namespaced API: iota_ core methods, iotax_ coin/indexer/governance queries, and unsafe_ transaction builders

  • Checkpoints: Chain progress is measured in checkpoints rather than blocks

  • NANOs Precision: Balances and gas are in NANOs (1 IOTA = 1,000,000,000 NANOs)

  • Build-Sign-Submit: The node builds unsigned unsafe_ transactions; clients sign and broadcast with iota_executeTransactionBlock

TECHNICAL DISCLAIMER: AUTHORITATIVE JSON-RPC API SPECIFICATION.

GetBlock's RPC API reference documentation is provided exclusively for informational purposes and to optimize the developer experience. The canonical specification is the IOTA node JSON-RPC API, published at docs.iota.org/iota-api-ref; protocol and developer documentation is at docs.iota.org.

Network Information

Property
Value

Network Name

IOTA Mainnet

Protocol

Move / object model (IOTA Rebased)

Native Currency

IOTA (1 IOTA = 1,000,000,000 NANOs)

Contract Language

Move

API

JSON-RPC 2.0 over HTTP

Chain Progress

Checkpoints

Base URL

Supported Networks

Network
JSON-RPC
WSS
Frankfurt, Germany
New York, USA
Singapore, Singapore

Mainnet

✅

❌

✅

✅

✅

Quickstart

1

Setup project

2

Install dependency

3

Add code

4

Run the script

5

Response

1

Setup project

2

Install dependency

3

Add code

4

Run the script

Available Methods

Read API

Method
Description

iota_getChainIdentifier

Returns the chain identifier, a short hex string derived from the genesis checkpoint digest, that uniquely identifies the IOTA network (mainnet vs a testnet)

iota_getLatestCheckpointSequenceNumber

Returns the sequence number of the most recently executed checkpoint

iota_getCheckpoint

Returns a checkpoint by its sequence number or digest, including its timestamp, the transaction digests it contains, and its epoch

iota_getCheckpoints

Returns a paginated list of checkpoints in ascending or descending order from a cursor

iota_getObject

Returns the current state of an object by its ID, with selectable fields (type, owner, content, bcs, previous transaction)

iota_multiGetObjects

Returns the state of several objects in one call, each with the same display options

iota_tryGetPastObject

Returns an object as it existed at a specific version, if the node still retains that historical version

iota_tryMultiGetPastObjects

Returns several objects at specific past versions in one call

iota_getTransactionBlock

Returns a transaction block by digest, with selectable fields: input, effects, events, object changes, and balance changes

iota_multiGetTransactionBlocks

Returns several transaction blocks by digest in one call, with shared display options

iota_getEvents

Returns all events emitted by a given transaction block

iota_getTotalTransactionBlocks

Returns the total number of transaction blocks the network has executed since genesis

iota_getProtocolConfig

Returns the protocol configuration (feature flags and limits) for a given protocol version, defaulting to the latest

iota_isTransactionIndexedOnNode

Returns whether a given transaction digest has been indexed on the serving node, so a client knows when read-after-write queries will succeed

Write API

Method
Description

iota_executeTransactionBlock

Submits a signed transaction block (BCS-serialized) with its signatures for execution, and returns the requested effects

iota_dryRunTransactionBlock

Dry-runs a transaction block against the current state and returns its predicted effects and gas cost, without committing it

iota_devInspectTransactionBlock

Simulates a transaction from its components for inspection, returning execution results including Move return values — without needing valid gas or signatures

Move Utils

Method
Description

iota_getNormalizedMoveModulesByPackage

Returns structured (normalized) representations of every Move module in a published package, including its structs and functions

iota_getNormalizedMoveModule

Returns a structured representation of a single Move module: its structs, exposed functions, and friends

iota_getNormalizedMoveFunction

Returns a structured representation of a single Move function, including its parameter and return types and visibility

iota_getNormalizedMoveStruct

Returns a structured representation of a Move struct, including its fields and abilities

iota_getMoveFunctionArgTypes

Returns the argument types (object vs pure) of a Move function, which a client needs to correctly place arguments when building a call

Coin Query

Method
Description

iotax_getBalance

Returns an address's total balance for a single coin type (IOTA by default), summed across all its coin objects

iotax_getAllBalances

Returns the total balance for every coin type an address owns, in one call

iotax_getCoins

Returns an address's individual Coin objects for a given coin type, paginated — the inputs you select when building a payment

iotax_getAllCoins

Returns all Coin objects an address owns across every coin type, paginated

iotax_getCoinMetadata

Returns the metadata (symbol, name, decimals, icon) for a coin type, used to display token amounts correctly

iotax_getTotalSupply

Returns the total supply of a coin type — for a regulated/custom coin, the amount its TreasuryCap has minted

iotax_getCirculatingSupply

Returns a summary of the circulating supply of the native IOTA token

Extended API

Method
Description

iotax_getOwnedObjects

Returns the objects owned by an address, with an optional query filter (by type, struct, or owner) and display options, paginated

iotax_queryTransactionBlocks

Queries transaction blocks matching a filter (by sender, recipient, input/changed object, Move function, or time range), paginated

iotax_queryEvents

Queries events matching a filter (by package, module, event type, sender, or time range), paginated

iotax_getDynamicFields

Lists the dynamic fields attached to a parent object (for example, entries of an on-chain table), paginated

iotax_getDynamicFieldObject

Returns the full object stored at a specific dynamic field of a parent object, addressed by the field name

iotax_iotaNamesLookup

Resolves an IOTA name (the IOTA naming service) to its registry record, including the address it points to

iotax_iotaNamesReverseLookup

Resolves an address to its primary registered IOTA name, if any

iotax_getCurrentEpoch (dedicated)

Returns information about the current epoch: its number, validators, start time, and reference gas price

iotax_getNetworkMetrics (dedicated)

Returns live network metrics — current TPS, peak TPS, total objects, addresses, packages, and current epoch/checkpoint

iotax_getTotalTransactions (dedicated)

Returns the total number of transactions recorded by the indexer

Governance

Method
Description

iotax_getReferenceGasPrice

Returns the network's current reference gas price in NANOs, the baseline a transaction's gas price should meet or exceed to be included

iotax_getLatestIotaSystemStateV2

Returns the latest on-chain system state on protocol version 5 and above: epoch, protocol version, the active validator set, staking pools, and system parameters

iotax_getCommitteeInfo

Returns the validator committee (public keys and voting power) for an epoch, defaulting to the latest

iotax_getStakes

Returns all delegated stakes owned by an address, grouped by validator, including the principal and estimated rewards

iotax_getStakesByIds

Returns delegated stakes for the given StakedIota object IDs

iotax_getValidatorsApy

Returns the annualized percentage yield (APY) for each validator, for comparing staking returns

iotax_getTimelockedStakes

Returns all timelocked delegated stakes owned by an address — stakes whose principal is subject to a time lock

Transaction Builder

Method
Description

unsafe_moveCall

Builds (but does not sign or submit) an unsigned transaction that calls a Move entry function, returning BCS tx bytes ready to sign

unsafe_pay

Builds an unsigned transaction that pays specified amounts of a coin to one or more recipients, selecting and splitting the given input coins

unsafe_payIota

Builds an unsigned transaction that pays IOTA to recipients, using the input IOTA coins themselves to pay gas (no separate gas coin)

unsafe_transferObject

Builds an unsigned transaction that transfers ownership of an object to a recipient address

unsafe_splitCoin

Builds an unsigned transaction that splits a coin object into several new coins of the specified amounts

unsafe_mergeCoins

Builds an unsigned transaction that merges one or more coins into a primary coin, consolidating balance into a single object

unsafe_requestAddStake

Builds an unsigned transaction that stakes IOTA coins with a validator, creating a delegated stake

unsafe_requestWithdrawStake

Builds an unsigned transaction that withdraws a previously delegated stake, returning principal and rewards

unsafe_publish

Builds an unsigned transaction that publishes a compiled Move package (its modules and dependencies) to the network

unsafe_batchTransaction

Builds an unsigned transaction that batches several operations (transfers, Move calls) into one atomic transaction

Support

For technical support and questions:

See Also

Last updated

Was this helpful?