Returns general information about the node.

GET 
/api/v1/info

Returns general information about the node.

Request

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

name stringrequired

The name of the node.

version stringrequired

The semantic version of the node.

isHealthy booleanrequired

Tells whether the node is healthy or not.

networkId stringrequired

Tells on which network the nodes operates on.

bech32HRP stringrequired

Tells whether the node supports mainnet or testnet addresses. Value iota indicates that the node supports mainnet addresses. Value atoi indicates that the node supports testnet addresses.

minPoWScore floatrequired

The Proof-of-Work difficulty for a message to be sent over the network to mitigate spam.

messagesPerSecond floatrequired

The current rate of new messages per second.

referencedMessagesPerSecond floatrequired

The current rate of referenced messages per second.

referencedRate floatrequired

The ratio of referenced messages in relation to new messages of the last confirmed milestone.

latestMilestoneTimestamp integerrequired

The timestamp of the latest seen milestone.

latestMilestoneIndex integerrequired

The most recent milestone known to the node.

confirmedMilestoneIndex integerrequired

The most recent milestone that has been confirmed by the node.

pruningIndex integerrequired

Tells from which starting point the node holds data.

features string[]required

The features that are supported by the node. For example, a node could support the Proof-of-Work (PoW) feature, which would allow the PoW to be performed by the node itself.

Example (from schema)

{
  "data": {
    "name": "string",
    "version": "string",
    "isHealthy": true,
    "networkId": "string",
    "bech32HRP": "string",
    "minPoWScore": 0,
    "messagesPerSecond": 0,
    "referencedMessagesPerSecond": 0,
    "referencedRate": 0,
    "latestMilestoneTimestamp": 0,
    "latestMilestoneIndex": 0,
    "confirmedMilestoneIndex": 0,
    "pruningIndex": 0,
    "features": [
      "string"
    ]
  }
}

default

{
  "data": {
    "name": "HORNET",
    "version": "0.6.0-alpha",
    "isHealthy": true,
    "networkId": "testnet7",
    "bech32HRP": "atoi",
    "minPoWScore": 4000,
    "messagesPerSecond": 17,
    "referencedMessagesPerSecond": 16.8,
    "referencedRate": 98.82352941176471,
    "latestMilestoneTimestamp": 1617802102,
    "latestMilestoneIndex": 480,
    "confirmedMilestoneIndex": 480,
    "pruningIndex": 0,
    "features": [
      "PoW"
    ]
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...