Status

Get Network Status

This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here.

POST/network/status

Body

application/json

network_identifier*NetworkIdentifier (object)

The network_identifier specifies which network a particular object is associated with.

metadataobject

Response

200500

Expected response to a valid request

Body

application/json

current_block_identifier*BlockIdentifier (object)

The block_identifier uniquely identifies a block in a particular network.

current_block_timestamp*Timestamp (integer (int64))

The timestamp of the block in milliseconds since the Unix Epoch. The timestamp is stored in milliseconds because some blockchains produce blocks more often than once a second.

Example: 1582833600000

genesis_block_identifier*BlockIdentifier (object)

The block_identifier uniquely identifies a block in a particular network.

oldest_block_identifierBlockIdentifier (object)

The block_identifier uniquely identifies a block in a particular network.

sync_statusSyncStatus (object)

SyncStatus is used to provide additional context about an implementation's sync status. This object is often used by implementations to indicate healthiness when block data cannot be queried until some sync phase completes or cannot be determined by comparing the timestamp of the most recent block with the current time.

peersarray of Peer (object)

Request

JavaScriptCurlPython

const response = await fetch('/network/status', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "network_identifier": {
        "blockchain": "bitcoin",
        "network": "mainnet"
      }
    }),
});
const data = await response.json();

Response

200500

{
  "current_block_identifier": {
    "index": 1123941,
    "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
  },
  "current_block_timestamp": 1582833600000,
  "genesis_block_identifier": {
    "index": 1123941,
    "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
  },
  "oldest_block_identifier": {
    "index": 1123941,
    "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
  },
  "sync_status": {
    "current_index": 100,
    "target_index": 150,
    "stage": "header sync",
    "synced": false
  },
  "peers": [
    {
      "peer_id": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
    }
  ]
}