Skip to content

REST Version & Health

REST endpoints for version and health

Returns version information for blockd and connected services. Available before blockd reaches ready state.

GET /version

Response:

{
"blockd": {
"version": "0.3.0-alpha.1",
"name": "my-node"
},
"core": {
"network": "signet",
"version": 290000,
"subversion": "/Satoshi:29.0.0/"
},
"indexer": {
"version": "Fulcrum 2.0",
"protocol": "1.4"
}
}
FieldDescription
blockd.nameOptional configurable string. See Server Configuration
core.versionInteger version format — 290000 = 29.0.0
core.subversionRaw user agent string from bitcoind’s getnetworkinfo
core.networkActive chain, auto-detected at startup. See Network detection
indexer.versionVersion string returned by Fulcrum
indexer.protocolProtocol version returned by Fulcrum

Returns server health. Available before ready state — suitable for readiness probes.

Level controls response verbosity; numeric and named aliases are equivalent.

LevelAliasDescription
0basicServer state only
1tipAdds current block tip
2detailedAdds bitcoind and indexer status
GET /health # defaults to level 0 (basic)
GET /health/0
GET /health/basic
GET /health/1
GET /health/tip
GET /health/2
GET /health/detailed

For the complete health response schema, field reference, state tables, IBD fields, and ZMQ monitoring documentation, see Health & IBD Reference.