{{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API Service

Websocket

Endpoint Description

wss://{{ hostname }}{{ network.val === '' ? '' : '/' + network.val }}/api/v1/ws Default push: {{ '{' }} action: 'want', data: ['blocks', ...] {{ '}' }} to express what you want pushed. Available: blocks, mempool-block, live-2h-chart, and stats.

Push transactions related to address: {{ '{' }} 'track-address': '3PbJ...bF9B' {{ '}' }} to receive all new transactions containing that address as input or output. Returns an array of transactions. address-transactions for new mempool transactions, and block-transactions for new block confirmed transactions.

Endpoint	Description
wss://{{ hostname }}{{ network.val === '' ? '' : '/' + network.val }}/api/v1/ws	Default push: `{{ '{' }} action: 'want', data: ['blocks', ...] {{ '}' }}` to express what you want pushed. Available: `blocks`, `mempool-block`, `live-2h-chart`, and `stats`. Push transactions related to address: `{{ '{' }} 'track-address': '3PbJ...bF9B' {{ '}' }}` to receive all new transactions containing that address as input or output. Returns an array of transactions. `address-transactions` for new mempool transactions, and `block-transactions` for new block confirmed transactions.

Mempool

Endpoint	Description
GET {{ network.val === '' ? '' : '/' + network.val }}/api/mempool	Returns current mempool backlog statistics.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/mempool/txids	Get the full list of txids in the mempool as an array. The order of the txids is arbitrary and does not match bitcoind.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/mempool/recent	Get a list of the last 10 transactions to enter the mempool. Each transaction object contains simplified overview data, with the following fields: `txid`, `fee`, `vsize`, and `value`.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/v1/fees/recommended	Returns our currently suggested fees for new transactions.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/v1/fees/mempool-blocks	Returns current mempool as projected blocks.

Blocks

Endpoint	Description
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block/:hash	Returns details about a block. Available fields: `id`, `height`, `version`, `timestamp`, `bits`, `nonce`, `merkle_root`, `tx_count`, `size`, `weight`, `proof`, and `previousblockhash`.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block/:hash/status	Returns the confirmation status of a block. Available fields: `in_best_chain` (boolean, false for orphaned blocks), `next_best` (the hash of the next block, only available for blocks in the best chain).
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block/:hash/txs[/:start_index]	Returns a list of transactions in the block (up to 25 transactions beginning at `start_index`). Transactions returned here do not have the `status` field, since all the transactions share the same block and confirmation status.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block/:hash/txids	Returns a list of all txids in the block.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block/:hash/txid/:index	Returns the transaction at index `:index` within the specified block.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block/:hash/txid/raw	Returns the raw block representation in binary.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/block-height/:height	Returns the hash of the block currently at `:height`.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/blocks[/:start_height]	Returns the 10 newest blocks starting at the tip or at `:start_height` if specified.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/blocks/tip/height	Returns the height of the last block.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/blocks/tip/hash	Returns the hash of the last block.

Transactions

Endpoint	Description
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid	Returns details about a transaction. Available fields: `txid`, `version`, `locktime`, `size`, `weight`, `fee`, `vin`, `vout`, and `status`.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/status	Returns the confirmation status of a transaction. Available fields: `confirmed` (boolean), `block_height` (optional), and `block_hash` (optional).
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/hex	Returns a transaction serialized as hex.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/raw	Returns a transaction as binary data.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/merkleblock-proof	Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/merkle-proof	Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/outspend/:vout	Returns the spending status of a transaction output. Available fields: `spent` (boolean), `txid` (optional), `vin` (optional), and `status` (optional, the status of the spending tx).
GET {{ network.val === '' ? '' : '/' + network.val }}/api/tx/:txid/outspends	Returns the spending status of all transaction outputs.
POST {{ network.val === '' ? '' : '/' + network.val }}/api/tx	Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The `txid` will be returned on success.

Addresses

Endpoint	Description
GET {{ network.val === '' ? '' : '/' + network.val }}/api/address/:address	Returns details about an address. Available fields: `address`, `chain_stats`, and `mempool_stats`. {{ '{' }}chain,mempool{{ '}' }}_stats each contain an object with `tx_count`, `funded_txo_count`, `funded_txo_sum`, `spent_txo_count`, and `spent_txo_sum`.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/address/:address/txs	Get transaction history for the specified address/scripthash, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. You can request more confirmed transactions using `:last_seen_txid` (see below).
GET {{ network.val === '' ? '' : '/' + network.val }}/api/address/:address/txs/chain	Get confirmed transaction history for the specified address/scripthash, sorted with newest first. Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.
GET {{ network.val === '' ? '' : '/' + network.val }}/api/address/:address/txs/mempool	Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
GET {{ network.val === '' ? '' : '/' + network.val }}/api/address/:address/utxo	Get the list of unspent transaction outputs associated with the address/scripthash. Available fields: `txid`, `vout`, `value`, and `status` (with the status of the funding tx).There is also a `valuecommitment` field that may appear in place of `value`, plus the following additional fields: `asset`/`assetcommitment`, `nonce`/`noncecommitment`, `surjection_proof`, and `range_proof`.

Assets

Endpoint	Description
GET /liquid/api/asset/:asset_id	Returns information about a Liquid asset.
GET /liquid/api/asset/:asset_id/txs[/mempool\|/chain]	Returns transactions associated with the specified Liquid asset. For the network's native asset, returns a list of peg in, peg out, and burn transactions. For user-issued assets, returns a list of issuance, reissuance, and burn transactions. Does not include regular transactions transferring this asset.
GET /liquid/api/asset/:asset_id/supply[/decimal]	Get the current total supply of the specified asset. For the native asset (L-BTC), this is calculated as [chain,mempool]_stats.peg_in_amount - [chain,mempool]_stats.peg_out_amount - [chain,mempool]_stats.burned_amount. For issued assets, this is calculated as [chain,mempool]_stats.issued_amount - [chain,mempool]_stats.burned_amount. Not available for assets with blinded issuances. If /decimal is specified, returns the supply as a decimal according to the asset's divisibility. Otherwise, returned in base units.

BSQ

Endpoint	Description
GET /bisq/api/stats	Returns statistics about all Bisq transactions.
GET /bisq/api/tx/:txid	Returns details about a Bisq transaction.
GET /bisq/api/txs/:index/:length	Returns :length of latest Bisq transactions, starting from :index.
GET /bisq/api/block/:hash	Returns all Bisq transactions that exist in a Bitcoin block.
GET /bisq/api/blocks/:index/:length	Returns :length Bitcoin blocks that contain Bisq transactions, starting from :index.
GET /bisq/api/blocks/tip/height	Returns the most recently processed Bitcoin block height processed by Bisq.
GET /bisq/api/address/:address	Returns all Bisq transactions belonging to a Bitcoin address, with 'B' prefixed in front of the address.