Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IOTA Read API

Core read operations: objects, checkpoints, transactions, events, protocol config

IOTA Read API is one of 17 APIs that IOTA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Read. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 11 paths. It is described by OpenAPI 3.0.1, at version 0.

Requests are made against a single base URL, /.

11 operations 11 paths 0 schemas 11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0
Base URL
https://api.mainnet.iota.cafe:443
Authentication
API Key
Resource Areas
1

Authentication & Security 1

IOTA Read API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT Token

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 POST. Each is listed below with its method, path, parameters, and response codes.

Read 11

Core read operations: objects, checkpoints, transactions, events, protocol config

POST
/iota_getChainIdentifier
iotagetChainIdentifier
iota_getChainIdentifier body → 200default
POST
/iota_getCheckpoint
iotagetCheckpoint
iota_getCheckpoint body → 200default
POST
/iota_getCheckpoints
iotagetCheckpoints
iota_getCheckpoints body → 200default
POST
/iota_getEvents
iotagetEvents
iota_getEvents body → 200default
POST
/iota_getLatestCheckpointSequenceNumber
iotagetLatestCheckpointSequenceNumber
iota_getLatestCheckpointSequenceNumber body → 200default
POST
/iota_getObject
iotagetObject
iota_getObject body → 200default
POST
/iota_getProtocolConfig
iotagetProtocolConfig
iota_getProtocolConfig body → 200default
POST
/iota_multiGetObjects
iotamultiGetObjects
iota_multiGetObjects body → 200default
POST
/iota_tryGetPastObject
iotatryGetPastObject
iota_tryGetPastObject body → 200default
POST
/iota_tryMultiGetPastObjects
iotatryMultiGetPastObjects
iota_tryMultiGetPastObjects body → 200default
POST
/iota_view
iotaview
iota_view body → 200default

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iota-read-api-openapi.yml Raw ↑

Other APIs IOTA publishes across the network.

IOTA GraphQL API
IOTA auth API
IOTA chains API
IOTA Coin Query API
IOTA corecontracts API
IOTA Extended API
IOTA Governance API
IOTA Health API
IOTA metrics API
IOTA Move Utils API
IOTA node API
IOTA requests API