v1

latestOpenAPI 3.0.02026-07-174823135.4 KB

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"
}