Skip to main content
GET
Get chain tip

Authorizations

X-Api-Key
string
header
required

API key (programmatic access — recommended)

Send your API key in the X-Api-Key header. Keys start with nxs_ and are created in the dashboard (or via POST /api/keys with a session JWT).

Each key is scoped to one chain and one network (for example cardano-mainnet), fixed at creation time. It cannot query a different network on the same chain, and it cannot query a different chain at all. A mismatched network parameter returns 400 Network Mismatch. Create one key per chain and network under the same account.

This is the credential most integrations should use.

Query Parameters

network
enum<string>
Available options:
CARDANO_MAINNET,
CARDANO_PREPROD,
CARDANO_PREVIEW,
APEX_PRIME_MAINNET,
APEX_VECTOR_MAINNET,
APEX_VECTOR_TESTNET,
MIDNIGHT_MAINNET,
MIDNIGHT_PREPROD,
MIDNIGHT_PREVIEW,
BITCOIN_MAINNET,
BITCOIN_TESTNET4

Response

OK

Bitcoin chain tip and sync state

chain
string
default:""

Network identifier (main, test, signet, regtest, testnet4)

blocks
integer<int64>
default:""

Block height of the local best chain

headers
integer<int64>
default:""

Header height (may be ahead of blocks during sync)

bestblockhash
string
default:""

Best block hash

time
integer<int64>
default:""

Block timestamp at the tip (epoch seconds)

difficulty
number<double>
default:""

Difficulty at the tip

verificationprogress
number<double>
default:""

Estimated proportion of chain verified, 0..1

initialblockdownload
boolean
default:false

True while the node is in initial block download

chainwork
string
default:""

Cumulative chainwork as hex

pruned
boolean
default:false

Whether bitcoind is pruned

{key}
any