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

The chains API from IOTA — 18 operation(s) for chains.

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

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

This API exposes 19 operations across 18 paths, and defines 26 schemas. It is described by OpenAPI 3.0.1, at version 0.

Requests are made against a single base URL, /.

19 operations 18 paths 26 schemas 1 DELETE8 GET9 POST1 PUT

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 chains API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT Token

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 1 DELETE, 8 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

chains 19
GET
/v1/chain
Get information about a specific chain
getChainInfo 1 param → 200
DELETE
/v1/chain/access-node/{peer}
Remove an access node.
removeAccessNode 1 param → 200401
PUT
/v1/chain/access-node/{peer}
Configure a trusted node to be an access node.
addAccessNode 1 param → 201401
POST
/v1/chain/activate/{chainID}
Activate a chain
activateChain 1 param → 200304401
POST
/v1/chain/callview
Call a view function on a contract by Hname
callView body → 200
POST
/v1/chain/chainrecord/{chainID}
Sets the chain record.
setChainRecord 1 param body → 201401
GET
/v1/chain/committee
Get information about the deployed committee
getCommitteeInfo 1 param → 200401
GET
/v1/chain/contracts
Get all available chain contracts
getContracts 1 param → 200401
POST
/v1/chain/deactivate
Deactivate a chain
deactivateChain → 200304401
POST
/v1/chain/dump-accounts
dump accounts information into a humanly-readable format
dump-accounts → 200401
POST
/v1/chain/estimategas-offledger
Estimates gas for a given off-ledger ISC request
estimateGasOffledger body → 200
POST
/v1/chain/estimategas-onledger
Estimates gas for a given on-ledger ISC request
estimateGasOnledger body → 200
POST
/v1/chain/evm
Ethereum JSON-RPC
→ default
GET
/v1/chain/evm/ws
Ethereum JSON-RPC (Websocket transport)
→ default
GET
/v1/chain/mempool
Get the contents of the mempool.
getMempoolContents → 200401
GET
/v1/chain/receipts/{requestID}
Get a receipt from a request ID
getReceipt 1 param → 200404
GET
/v1/chain/requests/{requestID}/wait
Wait until the given request has been processed by the node
waitForRequest 3 params → 200404408
POST
/v1/chain/rotate
Rotate a chain
rotateChain body → 200401
GET
/v1/chain/state/{stateKey}
Fetch the raw value associated with the given key in the chain state
getStateValue 1 param → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are RequestJSON (10 properties), ReceiptResponse (10 properties), ChainInfoResponse (8 properties), PeeringNodeStatusResponse (6 properties). Each schema is shown below with its type and property counts.

ValidationError
object
2 properties 2 required
ChainRecord
object
2 properties 2 required
CoinJSON
object
2 properties 2 required
Limits
object
4 properties 4 required
EstimateGasRequestOnledger
object
1 property 1 required
ReceiptResponse
object
10 properties 8 required
RequestJSON
object
10 properties 9 required
EstimateGasRequestOffledger
object
2 properties 2 required
FeePolicy
object
3 properties 3 required
Ratio32
object
2 properties 2 required
PeeringNodeStatusResponse
object
6 properties 6 required
UnresolvedVMErrorJSON
object
2 properties
ContractInfoResponse
object
2 properties 2 required
CallTargetJSON
object
2 properties 2 required
OnLedgerEstimationResponse
object
2 properties 2 required
ChainInfoResponse
object
8 properties 8 required
CommitteeInfoResponse
object
6 properties 6 required
AssetsJSON
object
2 properties 2 required
IotaObjectJSON
object
2 properties 2 required
BurnRecord
object
2 properties 2 required
L1EstimationResult
object
5 properties 5 required
ContractCallViewRequest
object
6 properties 5 required
StateResponse
object
1 property 1 required
RotateChainRequest
object
1 property
PublicChainMetadata
object
5 properties 5 required
CommitteeNode
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iota-chains-api-openapi.yml Raw ↑

Other APIs IOTA publishes across the network.

IOTA GraphQL API
IOTA auth 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 Read API
IOTA requests API