Placeholder.

Reference for the {{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API service.

General

GET Difficulty Adjustment
Description
Returns details about difficulty adjustment.

Markets

GET Market Currencies
Description
Provides list of available currencies for a given base currency.
GET Market Depth
Description
Provides list of open offer prices for a single market.
GET Market HLOC
Description
Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.
GET Markets
Description
Provides list of available markets.
GET Market Offers
Description
Provides list of open offer details for a single market.
GET Market Ticker
Description
Provides 24 hour price ticker for single market or all markets
GET Market Trades
Description
Provides list of completed trades for a single market.
GET Market Volumes
Description
Provides periodic volume data in terms of base currency for one or all markets.

General

GET Stats
Description
Returns statistics about all Bisq transactions.

Addresses

GET Address
Description
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 Address Transactions
Description
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 Address Transactions Chain
Description
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 Address Transactions Mempool
Description
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
GET Address UTXO
Description
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

GET Assets
Description
Returns information about a Liquid asset.
GET Asset Transactions
Description
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 Asset Supply
Description
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.

Blocks

GET Block
Description
Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, proof, and previousblockhash.
GET Block Header
Description
Returns the hex-encoded block header.
GET Block Height
Description
Returns the hash of the block currently at :height.
GET Block Raw
Description
Returns the raw block representation in binary.
GET Block Status
Get Block Status
Description
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 Block Tip Height
Description
Returns the height of the last block.
GET Block Tip Hash
Description
Returns the hash of the last block.
GET Block Transaction ID
Description
Returns the transaction at index :index within the specified block.
GET Block Transaction IDs
Description
Returns a list of all txids in the block.
GET Block Transactions
Description
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 Blocks
Description
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
GET Blocks
Description
Returns the 10 newest blocks starting at the tip or at :start_height if specified.

Fees

GET Mempool Blocks Fees
Description
Returns current mempool as projected blocks.
GET Recommended Fees
Description
Returns our currently suggested fees for new transactions.

Mempool

GET Mempool
Description
Returns current mempool backlog statistics.
GET Mempool Transactions IDs
Description
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 Mempool Recent
Description
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.

Transactions

GET Children Pay for Parent
Description
Returns the ancestors and the best descendant fees for a transaction.
GET Transaction
Description
Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
GET Transaction Hex
Description
Returns a transaction serialized as hex.
GET Transaction Merkleblock Proof
Description
Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
GET Transaction Merkle Proof
Description
Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
GET Transaction Outspend
Description
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 Transaction Outspends
Description
Returns the spending status of all transaction outputs.
GET Transaction Raw
Description
Returns a transaction as binary data.
GET Transaction Status
Description
Returns the confirmation status of a transaction. Available fields: confirmed (boolean), block_height (optional), and block_hash (optional).
GET Transactions
Get Mempool Txids
Description
Returns :length of latest Bisq transactions, starting from :index.
POST Transaction
Endpoint
POST /api/tx
Description
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.
Endpoint
{{ wrapUrl(network.val, code.websocket, true) }}
Description
Default push: {{ '{' }} action: 'want', data: ['blocks', ...] {{ '}' }} to express what you want pushed. Available: blocks, mempool-blocks, 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.