Returns general information about the node.
GET/api/core/v2/info
Returns general information about the node.
Request
Responses
- 200
- 403
- 500
Successful operation.
- application/json
- Schema
- Example (from schema)
- IOTA
- Shimmer
Schema
- Array [
- ]
The name of the node.
The semantic version of the node.
status required
Status of the node.
Tells whether the node is healthy or not.
latestMilestone objectrequired
Information about the latest seen milestone.
The index of the latest seen milestone.
The timestamp of the latest seen milestone.
The Milestone ID of the latest seen milestone. Hex-encoded with 0x prefix.
confirmedMilestone objectrequired
Information about the latest confirmed milestone.
The index of the latest confirmed milestone.
The timestamp of the latest confirmed milestone.
The Milestone ID of the latest confirmed milestone. Hex-encoded with 0x prefix.
The index of the milestone before which the tangle history is pruned.
metrics required
Node metrics.
The current rate of new blocks per second.
The current rate of referenced blocks per second.
The ratio of referenced blocks in relation to new blocks of the last confirmed milestone.
The supported protocol versions.
protocol required
Protocol parameters.
The Name of the network from which the networkId is derived.
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.
Current supply of base token. Plain string encoded number.
Protocol version used by the network.
The Proof-of-Work difficulty for a block to be sent over the network to mitigate spam.
The below max depth parameter of the network. New blocks can not reference parents that are more than belowMaxDepth old wrt the current milestone index. belowMaxDepth is the maximum allowed delta value between Oldest Cone Root Index (OCRI) of a given block in relation to the current Confirmed Milestone Index (CMI) before it gets lazy.
rentStructure required
The rent structure according to TIP-19.
Defines the rent of a single virtual byte denoted in IOTA tokens.
Defines the factor to be used for data only fields.
Defines the factor to be used for key/lookup generating fields.
pendingProtocolParameters ProtocolParamsMilestoneOpt[]required
Pending protocol parameters.
Defines the type of MilestoneOpt.
The milestone index at which these protocol parameters become active.
The to be applied protocol version.
The protocol parameters in binary form. Hex-encoded with 0x prefix.
baseToken required
Gives info about the base token the network uses.
The name of the base token of the network.
Ticker symbol of the token to be displayed on trading platforms.
The primary unit of the token.
Number of decimals the primary unit is divisible up to.
The name of the smallest possible denomination of the primary unit. subunit * 10^decimals = unit
Whether to use metric prefixes for displaying unit.
The features that are supported by the node. For example, a node could support the Proof-of-Work (pow) feature, which would allow the Proof-of-Work to be performed by the node itself. All features must be lowercase.
{
"name": "string",
"version": "string",
"status": {
"isHealthy": true,
"latestMilestone": {
"index": 0,
"timestamp": 0,
"milestoneId": "string"
},
"confirmedMilestone": {
"index": 0,
"timestamp": 0,
"milestoneId": "string"
},
"pruningIndex": 0
},
"metrics": {
"blocksPerSecond": 0,
"referencedBlocksPerSecond": 0,
"referencedRate": 0
},
"supportedProtocolVersions": [
0
],
"protocol": {
"networkName": "string",
"bech32Hrp": "string",
"tokenSupply": "string",
"version": 0,
"minPowScore": 0,
"belowMaxDepth": 0,
"rentStructure": {
"vByteCost": 0,
"vByteFactorData": 0,
"vByteFactoKey": 0
}
},
"pendingProtocolParameters": [
{
"type": 0,
"targetMilestoneIndex": 0,
"protocolVersion": 0,
"params": "string"
}
],
"baseToken": {
"name": "string",
"tickerSymbol": "string",
"unit": "string",
"decimals": 0,
"subunit": "string",
"useMetricPrefix": true
},
"features": [
"string"
]
}
{
"name": "HORNET",
"version": "0.6.0-alpha",
"status": {
"isHealthy": true,
"latestMilestone": {
"index": 480,
"timestamp": 1617802102,
"milestoneId": "0xb59ff329113b0da14343707450cb28d41fa18b295deabc4beb3fc1b6e70f9d9e"
},
"confirmedMilestone": {
"index": 480,
"timestamp": 1617802102,
"milestoneId": "0xb59ff329113b0da14343707450cb28d41fa18b295deabc4beb3fc1b6e70f9d9e"
},
"pruningIndex": 0
},
"metrics": {
"blocksPerSecond": 17,
"referencedBlocksPerSecond": 16.8,
"referencedRate": 98.82352941176471
},
"supportedProtocolVersions": [
2,
3
],
"protocol": {
"networkName": "iota-testnet",
"bech32Hrp": "atoi",
"tokenSupply": "2779530283277761",
"version": 2,
"minPowScore": 1000,
"belowMaxDepth": 15,
"rentStructure": {
"vByteCost": 500,
"vByteFactorData": 1,
"vByteFactorKey": 10
}
},
"pendingProtocolParameters": [
{
"type": 1,
"targetMilestoneIndex": 480,
"protocolVersion": 2,
"params": "0x03040560405060703940304956896"
},
{
"type": 1,
"targetMilestoneIndex": 485,
"protocolVersion": 2,
"params": "0x03040503045950393045930239392"
},
{
"type": 1,
"targetMilestoneIndex": 490,
"protocolVersion": 2,
"params": "0x02010290394032948950303939482"
}
],
"baseToken": {
"name": "IOTA",
"tickerSymbol": "MIOTA",
"unit": "IOTA",
"decimals": 0,
"useMetricPrefix": true
},
"features": [
"pow"
]
}
{
"name": "HORNET",
"version": "2.0.0-alpha8",
"status": {
"isHealthy": true,
"latestMilestone": {
"index": 480,
"timestamp": 1617802102,
"milestoneId": "0xb59ff329113b0da14343707450cb28d41fa18b295deabc4beb3fc1b6e70f9d9e"
},
"confirmedMilestone": {
"index": 480,
"timestamp": 1617802102,
"milestoneId": "0xb59ff329113b0da14343707450cb28d41fa18b295deabc4beb3fc1b6e70f9d9e"
},
"pruningIndex": 0
},
"metrics": {
"blocksPerSecond": 17,
"referencedBlocksPerSecond": 16.8,
"referencedRate": 98.82352941176471
},
"supportedProtocolVersions": [
2,
3
],
"protocol": {
"networkName": "shimmer-testnet",
"bech32Hrp": "rms",
"tokenSupply": "2779530283277761",
"version": 2,
"minPowScore": 1000,
"belowMaxDepth": 15,
"rentStructure": {
"vByteCost": 500,
"vByteFactorData": 1,
"vByteFactorKey": 10
}
},
"pendingProtocolParameters": [
{
"type": 1,
"targetMilestoneIndex": 480,
"protocolVersion": 2,
"params": "0x03040560405060703940304956896"
},
{
"type": 1,
"targetMilestoneIndex": 485,
"protocolVersion": 2,
"params": "0x03040503045950393045930239392"
},
{
"type": 1,
"targetMilestoneIndex": 490,
"protocolVersion": 2,
"params": "0x02010290394032948950303939482"
}
],
"baseToken": {
"name": "Shimmer",
"tickerSymbol": "SMR",
"unit": "SMR",
"decimals": 6,
"subunit": "glow",
"useMetricPrefix": false
},
"features": [
"pow"
]
}
Unsuccessful operation: indicates that the endpoint is not available for public use.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 403,
"message": "not available for public use"
}
}
Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 500,
"message": "internal server error"
}
}