Skip to content
LogoLogo

14. Node REST API

OpenAPI is served at /openapi.json. Errors are RFC 9457 problem+json with a stable code. Amounts are decimal strings.

GroupRoutes
chain, blocks/v1/chain, /v1/blocks, /v1/blocks/tip, /v1/blocks/{id}, /v1/blocks/{id}/raw
transactions/v1/txs (POST), /v1/txs/package (POST [parent, child]), /v1/txs/{txid}, /v1/txs/{txid}/raw, /v1/txs/decode (POST)
addresses/v1/addresses/{a}, …/utxos, …/txs
assets/v1/assets, /v1/assets/{id_or_ticker}, /v1/assets/{key}/frozen, /v1/tools/metadata-hash (POST)
mempool, fees/v1/mempool, /v1/fees
mining/v1/mining/template (header_hex, txs_hex, aux_hash, chain_id), /v1/mining/submit (POST header ‖ auxpow ‖ txs), /rpc (JSON-RPC createauxblock(address), submitauxblock(hash, auxpow), getauxblock)
finality/v1/checkpoints (signer group, latest, pending, finality floor), /v1/checkpoints (POST a signed checkpoint), /v1/txs/{txid}/proof (finality proof, §9.9)
events, network/v1/events (SSE), /v1/network
light clients/v1/blocks/{id}/filter (filter, header, coinbase, merkle branch), /v1/filters/headers?start=&count=
upgrades/v1/deployments (state of every deployment at the next height)
ops/healthz, /readyz, /metrics
admin (Bearer token)/v1/admin/peers, /v1/admin/bans, /v1/admin/mine, /v1/admin/integrity