Returns various state info regarding block chain processing.

Returns various state info regarding block chain processing. Only supports JSON as output format.

Responses

🟢200successful operation

application/json

Body

chain

enum<string>

optional

Current network name as defined in BIP70 (main, test, regtest)

Allowed values:

maintestregtest

blocks

integer <int64>

optional

The current number of blocks processed in the server

headers

integer <int64>

optional

The current number of headers we have validated

bestblockhash

string

optional

The hash of the currently best block

difficulty

integer <int64>

optional

The current difficulty

mediantime

integer <int32>

optional

The median time of the 11 blocks before the most recent block on the blockchain

verificationprogress

integer <int32>

optional

Estimate of verification progress [0..1]

initialblockdownload

boolean

optional

chainwork

string

optional

Total amount of work in active chain, in hexadecimal

size_on_disk

integer <int64>

optional

pruned

boolean

optional

If the blocks are subject to pruning

softforks

array[object (BIP) {3}]

optional

status of softforks in progress

string

optional

The BIP number, or ? before being assigned

version

integer <int32>

optional

The BIP version number

reject

object

optional

the BIP rejection status

bip9_softforks

object

optional

status of BIP9 softforks in progress

name

object (BIP9)

optional

warnings

string

optional

An eventual warning on the current build status.

Example

{
  "chain": "main",
  "blocks": 0,
  "headers": 0,
  "bestblockhash": "string",
  "difficulty": 0,
  "mediantime": 0,
  "verificationprogress": 0,
  "initialblockdownload": true,
  "chainwork": "string",
  "size_on_disk": 0,
  "pruned": true,
  "softforks": [
    {
      "id": "string",
      "version": 0,
      "reject": {
        "status": true
      }
    }
  ],
  "bip9_softforks": {
    "name": {
      "status": "defined",
      "startTime": 0,
      "timeout": 0,
      "since": 0
    }
  },
  "warnings": "string"
}

Returns various state info regarding block chain processing.

Request

Request samples

Responses