Blockchain

Get blockchain status

Retrieves the connection and synchronization status of the specified cryptocurrency's blockchain.

get/v1/cryptos/{cryptoCode}/status

Path parameters

cryptoCodestring required

The cryptocurrency code to track (e.g., 'BTC' for Bitcoin, 'LTC' for Litecoin).

Response

Status retrieved successfully.

isFullySynchedboolean

true if both, NBXplorer and the full node, are fully synched with the network

syncHeightinteger

NBXplorer's current sync height

networkTypestring

cryptoCodestring

instanceNamestring nullable

The instance name given to your server via --instancename or NBXPLORER_INSTANCENAME

supportedCryptoCodesstring[]

versionstring

Example response

{
  "bitcoinStatus": {
    "blocks": 103,
    "headers": 103,
    "verificationProgress": 1,
    "isSynched": true,
    "incrementalRelayFee": 1,
    "minRelayTxFee": 1,
    "capabilities": {
      "canScanTxoutSet": true,
      "canSupportSegwit": true,
      "canSupportTaproot": true,
      "canSupportTransactionCheck": true
    }
  },
  "isFullySynched": true,
  "syncHeight": 103,
  "networkType": "Regtest",
  "cryptoCode": "BTC",
  "instanceName": "MyInstance",
  "supportedCryptoCodes": [
    "BTC"
  ],
  "version": "1.0.3.5"
}

Changes

Changed in 3 of the 40 revisions of this API.139

Nov 25, 20248d0c25e4d26f38See the full diff
- ●
  removed the optional property blocks from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property headers from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property isSynchronized from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property bitcoinStatus to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property cryptoCode to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property instanceName to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property isFullySynched to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property networkType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property supportedCryptoCodes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property syncHeight to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property version to the response with the 200 status
  response-optional-property-added
Nov 25, 202472a2dfa269761See the full diff
- ○
  endpoint added
  endpoint-added
Nov 18, 2024b5092f2045991See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history