Protocol Documentation

Block header data, as well as metadata stored by the node.

List of transactions or transaction hashes.

Just the transaction hash, little-endian.

A marshaled transaction.

The double sha256 hash of the six header fields in the first 80 bytes of the block, when encoded according the bitcoin protocol, little-endian. sha256(sha256(encoded_header))

The block number, an incremental index for each block mined.

A version number to track software/protocol upgrades.

Hash of the previous block, little-endian.

The root of the Merkle Tree built from all transactions in the block, little-endian.

When mining of the block started, expressed in seconds since 1970-01-01.

Difficulty in Compressed Target Format.

A random value that was generated during block mining which happened to result in a computed block hash below the difficulty target at the time.

Number of blocks in a chain, including the block itself upon creation.

Difficulty target at time of creation.

Hash of the next block in this chain, little-endian.

Size of the block in bytes.

The median block time of the latest 11 block timestamps.

Whether the block is connected to the chain.

Marshaled block header data, as well as metadata stored by the node.

A Block.

Binary block, serialized using bitcoin protocol encoding.

The address to query transactions, in lowercase cashaddr format. The network prefix is optional (i.e. "cashaddress:").

The number of confirmed transactions to skip, starting with the oldest first. Does not affect results of unconfirmed transactions.

Specify the number of transactions to fetch.

Recommended. Only get transactions after (or within) a starting block identified by hash, little-endian.

Recommended. Only get transactions after (or within) a starting block identified by block number.

Transactions that have been included in a block.

Transactions in mempool which have not been included in a block.

The address to query transactions, in lowercase cashaddr format. The network identifier is optional (i.e. "cashaddress:").

When `include_mempool` is true, unconfirmed transactions from mempool are returned. Default is false.

List of unspent outputs.

The block hash as a byte array or base64 encoded string, little-endian.

The block number.

A compact filter matching input outpoints and public key scripts contained in a block (encoded according to BIP158).

The block hash as a byte array or base64 encoded string, little-endian.

The block number.

Marshaled block header data, as well as metadata.

The block hash as a byte array or base64 encoded string, little-endian.

The block number.

When `full_transactions` is true, full transactions are returned instead of just hashes. Default is false.

A marshaled block.

Which network the node is operating on.

The current number of blocks on the longest chain.

The hash of the best (tip) block in the most-work fully-validated chain, little-endian.

Threshold for adding new blocks.

Median time of the last 11 blocks.

When `tx_index` is true, the node has full transaction index enabled.

When `addr_index` is true, the node has address index enabled and may be used with call related by address.

A list of block hashes known to the client (most recent first) which is exponentially sparser toward the genesis block (0), little-endian. Common practice is to include all of the last 10 blocks, and then 9 blocks for each order of ten thereafter.

hash of the latest desired block header, little-endian; only blocks occurring before the stop will be returned.

List of block headers.

The count of transactions in the mempool

The size in bytes of all transactions in the mempool

When `full_transactions` is true, full transaction data is provided instead of just transaction hashes. Default is false.

List of unconfirmed transactions.

The transaction hash, little-endian.

The transaction data.

A transaction hash, little-endian.

Block header information for the corresponding transaction

A list containing the transaction hash, the adjacent leaf transaction hash and the hashes of the highest nodes in the merkle tree not built with the transaction. Proof hashes are ordered following transaction order, or left to right on the merkle tree

Binary representing the location of the matching transaction in the full merkle tree, starting with the root (`1`) at position/level 0, where `1` corresponds to a left branch and `01` is a right branch.

The address to query transactions, in lowercase cashaddr format. The network prefix is optional (i.e. "cashaddress:").

The number of confirmed transactions to skip, starting with the oldest first. Does not affect results of unconfirmed transactions.

Specify the number of transactions to fetch.

Recommended. Only return transactions after some starting block identified by hash, little-endian.

Recommended. Only return transactions after some starting block identified by block number.

Transactions that have been included in a block.

Transactions in mempool which have not been included in a block.

The block hash as a byte array or base64 encoded string, little-endian.

The block number.

Raw block data (with header) serialized according the the bitcoin block protocol.

A transaction hash, little-endian.

Raw transaction in bytes.

A transaction hash, little-endian.

A marshaled transaction.

The hash of the transaction, little-endian.

The number of the output, starting from zero.

When include_mempool is true, unconfirmed transactions from mempool are returned. Default is false.

A reference to the related input.

Locking script dictating how funds can be spent in the future

Amount in satoshi.

When is_coinbase is true, the transaction was the first in a block, created by a miner, and used to pay the block reward

The index number of the block containing the transaction creating the output.

The time when the transaction was added too the pool.

The block height when the transaction was added to the pool.

The total fee in satoshi the transaction pays.

The fee in satoshi per kilobyte the transaction pays.

The priority of the transaction when it was added to the pool.

The encoded transaction.

Transaction hash, little-endian.

When full_block is true, a complete marshaled block is sent. See `Block`. Default is false, block metadata is sent. See `BlockInfo`.

When full_transactions is true, provide full transaction info for a marshaled block. Default is false, only the transaction hashes are included for a marshaled block. See `TransactionData`.

When serialize_block is true, blocks are serialized using bitcoin protocol encoding. Default is false, block will be Marshaled (see `BlockInfo` and `BlockNotification`)

Subscribe to a filter. add items to a filter

Unsubscribe to a filter, remove items from a filter

When include_mempool is true, new unconfirmed transactions from mempool are included apart from the ones confirmed in a block.

When include_in_block is true, transactions are included when they are confirmed. This notification is sent in addition to any requested mempool notifications.

When serialize_tx is true, transactions are serialized using bitcoin protocol encoding. Default is false, transaction will be Marshaled (see `Transaction`, `MempoolTransaction` and `TransactionNotification`)

The double sha256 hash of the encoded transaction, little-endian. sha256(sha256(encoded_transaction))

The version of the transaction format.

List of inputs.

List of outputs.

The block height or timestamp after which this transaction is allowed. If value is greater than 500 million, it is assumed to be an epoch timestamp, otherwise it is treated as a block-height. Default is zero, or lock.

The size of the transaction in bytes.

When the transaction was included in a block, in epoch time.

Number of blocks including proof of the transaction, including the block it appeared.

Number of the block containing the transaction.

Hash of the block the transaction was recorded in, little-endian.

The number of the input, starting from zero.

The related outpoint.

An unlocking script asserting a transaction is permitted to spend the Outpoint (UTXO)

As of BIP-68, the sequence number is interpreted as a relative lock-time for the input.

Amount in satoshi.

The pubkey_script of the previous output that is being spent.

The bitcoin addresses associated with this input.

The hash of the transaction containing the output to be spent, little-endian

The index of specific output on the transaction.

The number of the output, starting from zero.

The number of satoshis to be transferred.

The public key script used to pay coins.

The bitcoin addresses associated with this output.

The type of script.

The script expressed in Bitcoin Cash Script.

Filter by address(es)

Filter by output hash and index.

Filter by data elements contained in pubkey scripts.

Subscribe/Unsubscribe to everything. Other filters will be ignored.

Whether or not the transaction has been included in a block.

A transaction included in a block.

A transaction in mempool.

Binary transaction, serialized using bitcoin protocol encoding.

A reference to the output given by transaction hash and index.

The public key script used to pay coins.

The amount in satoshis

When is_coinbase is true, the output is the first in the block, a generation transaction, the result of mining.

The block number containing the UXTO.