API Docs

Current Version: v2.0.0

blocks

/block/$HASH
Returns the details of the block with the given hash.
/block/$HEIGHT
Returns the details of the block at the given height.
/block/header/$HASH
Returns the details of the block header with the given hash.
/block/header/$HEIGHT
Returns the details of the block header at the given height.
/blocks/tip
Returns basic details about the chain tip.

transactions

/tx/$TXID
Returns the details of the transaction with the given txid.

blockchain

/blockchain/utxo-set
Returns the latest UTXO Set snapshot. Warning: This call can be very slow, depending on node hardware and index configurations.

addresses

/address/$ADDRESS
Returns a summary of data pertaining to the given address. The output of this call will depend heavily on the configured 'Address API' (see .env-sample file). If an Address API is configured, transactions related to the given address will be returned (the below optional parameters apply to those transactions).
Optional parameters
limitNumber of transactions to return
offsetOffset into transactions
sortSorting direction for transactions ('desc'=new first, 'asc'=old first)

xpubs

/xyzpub/$XPUB
Returns details for the specified extended public key, including related keys and addresses.
Optional parameters
limitThe number of addresses to return
offsetOffset into the list of addresses
/xyzpub/addresses/$XPUB
Returns a list of addresses derived from the given [xyz]pub.
Optional parameters
receiveOrChange0 for 'receive' addresses (default); 1 for 'change' addresses
limitNumber of addresses to return
offsetOffset into addresses

mempool

/mempool/summary
Returns a summary of Bitcoin Core's mempool (full output from 'getmempoolinfo')

admin

/version
Returns the semantic version of the public API, which is maintained separate from the app version.