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 node API

The node API from IOTA — 11 operation(s) for node.

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

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

This API exposes 12 operations across 11 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 0.

Requests are made against a single base URL, /.

12 operations 11 paths 15 schemas 1 DELETE8 GET3 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 node API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT Token

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 8 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

node 12
GET
/v1/node/config
Return the Wasp configuration
getConfiguration → 200401
POST
/v1/node/dks
Generate a new distributed key
generateDKS body → 200401
GET
/v1/node/dks/{sharedAddress}
Get information about the shared address DKS configuration
getDKSInfo 1 param → 200401404
GET
/v1/node/info
Returns private information about this node.
getInfo → 200401
GET
/v1/node/owner/certificate
Gets the node owner
ownerCertificate → 200401
GET
/v1/node/peers
Get basic information about all configured peers
getAllPeers → 200401
GET
/v1/node/peers/identity
Get basic peer info of the current node
getPeeringIdentity → 200401
GET
/v1/node/peers/trusted
Get trusted peers
getTrustedPeers → 200401
POST
/v1/node/peers/trusted
Trust a peering node
trustPeer body → 200401
DELETE
/v1/node/peers/trusted/{peer}
Distrust a peering node
distrustPeer 1 param → 200401404
POST
/v1/node/shutdown
Shut down the node
shutdownNode → 200401
GET
/v1/node/version
Returns the node version.
getVersion → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are IotaCoinInfo (7 properties), DKSharesInfo (6 properties), PeeringNodeStatusResponse (6 properties), Protocol (6 properties). Each schema is shown below with its type and property counts.

ObjectType
object
1 property
Protocol
object
6 properties 6 required
NodeOwnerCertificateResponse
object
1 property 1 required
DKSharesInfo
object
6 properties 6 required
VersionResponse
object
1 property 1 required
ValidationError
object
2 properties 2 required
L1Params
object
2 properties 2 required
IotaCoinInfo
object
7 properties 7 required
PeeringNodeStatusResponse
object
6 properties 6 required
PeeringTrustRequest
object
3 properties 3 required
InfoResponse
object
4 properties 4 required
DKSharesPostRequest
object
3 properties 3 required
PeeringNodeIdentityResponse
object
4 properties 4 required
BigInt
object
1 property
Int
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iota-node-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 Read API
IOTA requests API