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

The metrics API from IOTA — 3 operation(s) for metrics.

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

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

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

Requests are made against a single base URL, /.

3 operations 3 paths 10 schemas 3 GET

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

  • Authorization — JWT Token

Paths & Operations 3

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

metrics 3
GET
/v1/metrics/chain/messages
Get chain specific message metrics.
getChainMessageMetrics → 200401404
GET
/v1/metrics/chain/pipe
Get chain pipe event metrics.
getChainPipeMetrics → 200401404
GET
/v1/metrics/chain/workflow
Get chain workflow metrics.
getChainWorkflowMetrics → 200401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ConsensusWorkflowMetrics (18 properties), ConsensusPipeMetrics (5 properties), OnLedgerRequestMetricItem (3 properties), StateAnchor (3 properties). Each schema is shown below with its type and property counts.

ValidationError
object
2 properties 2 required
ConsensusPipeMetrics
object
5 properties 5 required
StateAnchor
object
3 properties 3 required
OnLedgerRequest
object
2 properties 2 required
OnLedgerRequestMetricItem
object
3 properties 3 required
PublisherStateTransactionItem
object
3 properties 3 required
ConsensusWorkflowMetrics
object
18 properties 17 required
AnchorMetricItem
object
3 properties 3 required
StateTransaction
object
2 properties 2 required
ChainMessageMetrics
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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