Blockchain

Get blockchain status

Changed on Sep 29, 2026

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

get/v1/cryptos/{cryptoCode}/status

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP basic
TypeScript
https://skmtc.dev/btcpayserver/apis/nbxplorer-api/docs/v1/cryptos/:cryptoCode/status/get.ts
A function with typed inputs. Its response is checked against the schema.

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

Sep 29, 202652231f42c765 Revision changes
- breaking
  the response property became nullable for the status
- info
  api operation id GetStatus was added
Nov 25, 20248d0c25e4d26f Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (4 revisions)