Sign in

v1

latestOpenAPI 3.0.2CC0 1.0 Universal2026-07-17128129208.3 KB
info

Get the information about the Node

get/info

Response

Node info object

namestring required

Node's (peer) self-chosen name from config

appVersionstring required

Node's application version

fullHeightinteger nullable required

Height of the best block known to the node. Can be 'null' if state is empty (no full block is applied since node launch)

headersHeightinteger nullable required

The height of the best header (i.e. the one with the maximum height). Can be 'null' if state is empty (no header applied since node launch)

maxPeerHeightinteger nullable required

Maximum block height of connected peers. Can be 'null' if state is empty (no peer connected since node launch)

bestFullHeaderIdstring base16 required

Base16-encoded 32 byte modifier id

previousFullHeaderIdstring base16 required

Base16-encoded 32 byte modifier id

bestHeaderIdstring base16 required

Base16-encoded 32 byte modifier id

stateRootstring nullable required

Current UTXO set digest. Can be 'null' if state is empty (no full block is applied since node launch)

stateType'digest' | 'utxo' required

Whether the node is storing UTXO set or only its digest. Equals digest if only digest is stored, utxo if full UTXO set is stored.

stateVersionstring nullable required

Id of a block where UTXO set digest is taken from. Can be 'null' if no full block is applied since node launch.

isMiningboolean required

Whether the node is mining (i.e. generating blocks).

peersCountinteger required

Number of peers this node is connected with.

unconfirmedCountinteger required

Number of unconfirmed transactions in the mempool.

difficultyinteger nullable required

Difficulty on current bestFullHeaderId. Can be 'null' if no full block is applied since node launch. Difficulty is a BigInt integer.

currentTimeinteger required

Basic timestamp definition

launchTimeinteger required

Basic timestamp definition

headersScoreinteger nullable required

Cumulative difficulty of best headers-chain. Can be 'null' if no headers is applied since node launch. headersScore is a BigInt integer.

fullBlocksScoreinteger nullable required

Cumulative difficulty of best full blocks chain. Can be 'null' if no full block is applied since node launch. fullBlocksScore is a BigInt integer.

genesisBlockIdstring base16 required

Base16-encoded 32 byte modifier id

eip27Supportedboolean

Whether EIP-27 locked in

restApiUrlstring

Publicly accessible url of node which exposes restApi in firewall

Example response

{
  "name": "my-node-1",
  "appVersion": "0.0.1",
  "fullHeight": 667,
  "headersHeight": 667,
  "maxPeerHeight": 706162,
  "bestFullHeaderId": "3ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
  "previousFullHeaderId": "3ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
  "bestHeaderId": "3ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
  "stateRoot": "dab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
  "stateVersion": "fab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
  "isMining": true,
  "peersCount": 327,
  "unconfirmedCount": 327,
  "difficulty": 667,
  "currentTime": 1524143059077,
  "launchTime": 1524143059077,
  "genesisBlockId": "3ab9da11fc216660e974842cc3b7705e62ebb9e0bf5ff78e53f9cd40abadd117",
  "parameters": {
    "height": 667,
    "storageFeeFactor": 100000,
    "minValuePerByte": 360,
    "maxBlockSize": 1048576,
    "maxBlockCost": 104876,
    "blockVersion": 2,
    "tokenAccessCost": 100,
    "inputCost": 100,
    "dataInputCost": 100,
    "outputCost": 100
  },
  "eip27Supported": true,
  "restApiUrl": "https://example.com"
}