752 lines
19 KiB
Markdown
752 lines
19 KiB
Markdown
# mempool**JS** - Bitcoin API
|
|
|
|
Interface to access the Bitcoin `mainet`, `testnet`, `signet` APIs.
|
|
|
|
[Back to home](./README.md)
|
|
|
|
---
|
|
|
|
## **Features**
|
|
|
|
- Bitcoin
|
|
- Addresses
|
|
- [Get Address](#get-address)
|
|
- [Get Address Txs](#get-address-txs)
|
|
- [Get Address Txs Chain](#get-address-txs-chain)
|
|
- [Get Address Txs Mempool](#get-address-txs-mempool)
|
|
- [Get Address Txs Utxo](#get-address-txs-utxo)
|
|
- Assets
|
|
- [Get Asset](#get-asset)
|
|
- [Get Asset Txs](#get-asset-txs)
|
|
- [Get Asset Supply](#get-asset-supply)
|
|
- Blocks
|
|
- [Get Block](#get-block)
|
|
- [Get Block Status](#get-block-status)
|
|
- [Get Block Txs](#get-block-txs)
|
|
- [Get Block Txids](#get-block-txids)
|
|
- [Get Block Txid](#get-block-txid)
|
|
- [Get Block Raw](#get-block-raw)
|
|
- [Get Blocks Header](#get-blocks-header)
|
|
- [Get Blocks Height](#get-blocks-height)
|
|
- [Get Blocks](#get-blocks)
|
|
- [Get Blocks Tip Height](#get-blocks-tip-height)
|
|
- [Get Blocks Tip Hash](#get-blocks-tip-hash)
|
|
- Difficulty
|
|
- [Get Difficulty Adjustment](#get-difficulty-adjustment)
|
|
- Fees
|
|
- [Get Fees Recommended](#get-fees-recommended)
|
|
- [Get Fees Mempool Blocks](#get-fees-mempool-blocks)
|
|
- Mempool
|
|
- [Get Mempool](#get-mempool)
|
|
- [Get Mempool Recent](#get-mempool-recent)
|
|
- [Get Mempool Txids](#get-mempool-txids)
|
|
- Transactions
|
|
- [Get Tx](#get-tx)
|
|
- [Get Tx Status](#get-tx-status)
|
|
- [Get Tx Hex](#get-tx-hex)
|
|
- [Get Tx Raw](#get-tx-raw)
|
|
- [Get Tx Merkle Block Proof](#get-tx-merkle-block-proof)
|
|
- [Get Tx Merkle Proof](#get-tx-merkle-proof)
|
|
- [Get Tx Outspend](#get-tx-outspend)
|
|
- [Get Tx Outspends](#get-tx-outspends)
|
|
- [Post Tx Outspends]($post-tx-outspends)
|
|
- Websocket
|
|
- [Websocket Client](#websocket-client)
|
|
- [Websocket Server](#websocket-server)
|
|
- [Bisq](./README-bisq.md)
|
|
- [Liquid](./README-liquid.md)
|
|
|
|
---
|
|
|
|
### **Get 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`.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} address
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/addresses.ts) ] [ [HTML Example](examples/html/bitcoin/addresses.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { addresses },
|
|
} = mempoolJS();
|
|
|
|
const address = '1wizSAYSbuyXbt9d8JV8ytm5acqq2TorC';
|
|
|
|
const myAddress = await addresses.getAddress({ address });
|
|
console.log(myAddress);
|
|
```
|
|
|
|
### **Get 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`.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} address
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/addresses.ts) ] [ [HTML Example](examples/html/bitcoin/addresses.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { addresses },
|
|
} = mempoolJS();
|
|
|
|
const address = '1wizSAYSbuyXbt9d8JV8ytm5acqq2TorC';
|
|
|
|
const addressTxs = await addresses.getAddressTxs({ address });
|
|
console.log(addressTxs);
|
|
```
|
|
|
|
### **Get 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.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} address
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/addresses.ts) ] [ [HTML Example](examples/html/bitcoin/addresses.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { addresses },
|
|
} = mempoolJS();
|
|
|
|
const address = '1wizSAYSbuyXbt9d8JV8ytm5acqq2TorC';
|
|
|
|
const addressTxsChain = await addresses.getAddressTxsChain({ address });
|
|
console.log(addressTxsChain);
|
|
```
|
|
|
|
### **Get Address Txs Mempool**
|
|
|
|
Get unconfirmed transaction history for the specified `address/scripthash`. Returns up to 50 transactions (no paging).
|
|
|
|
**Parameters:**
|
|
|
|
- {string} address
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/addresses.ts) ] [ [HTML Example](examples/html/bitcoin/addresses.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { addresses },
|
|
} = mempoolJS();
|
|
|
|
const address = '1wizSAYSbuyXbt9d8JV8ytm5acqq2TorC';
|
|
|
|
const addressTxsMempool = await addresses.getAddressTxsMempool({ address });
|
|
console.log(addressTxsMempool);
|
|
```
|
|
|
|
### **Get Address Txs 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).
|
|
|
|
**Parameters:**
|
|
|
|
- {string} address
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/addresses.ts) ] [ [HTML Example](examples/html/bitcoin/addresses.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const { addresses } = mempoolJS();
|
|
|
|
const addressTxsUtxo = await addresses.getAddressTxsUtxo('15e10745f15593a...');
|
|
console.log(addressTxsUtxo);
|
|
```
|
|
|
|
### **Get Block**
|
|
|
|
Returns details about a block. Available fields: `id`, `height`, `version`, `timestamp`, `bits`, `nonce`, `merkle_root`, `tx_count`, `size`, `weight`, and `previousblockhash`.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} hash
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const hash = '000000000000000015dc777b3ff2611091336355d3f0ee9766a2cf3be8e4b1ce';
|
|
|
|
const block = await blocks.getBlock({ hash });
|
|
console.log(block);
|
|
```
|
|
|
|
### **Get Block 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).
|
|
|
|
**Parameters:**
|
|
|
|
- {string} hash
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const hash = '000000000000000015dc777b3ff2611091336355d3f0ee9766a2cf3be8e4b1ce';
|
|
|
|
const blockStatus = await blocks.getBlockStatus({ hash });
|
|
console.log(blockStatus);
|
|
```
|
|
|
|
### **Get Block Txs**
|
|
|
|
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.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} params.hash
|
|
- {number} params.start_index
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const hash = '000000000000000015dc777b3ff2611091336355d3f0ee9766a2cf3be8e4b1ce';
|
|
|
|
const blockTxs = await blocks.getBlockTxs({ hash });
|
|
console.log(blockTxs);
|
|
```
|
|
|
|
### **Get Block Txids**
|
|
|
|
Returns a list of all txids in the block.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} hash
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const hash = '000000000000000015dc777b3ff2611091336355d3f0ee9766a2cf3be8e4b1ce';
|
|
|
|
const blockTxids = await blocks.getBlockTxids({ hash });
|
|
console.log(blockTxids);
|
|
```
|
|
|
|
### **Get Block Txid**
|
|
|
|
Returns the transaction at index :index within the specified block.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} params.hash
|
|
- {number} params.index
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const hash = '000000000000000015dc777b3ff2611091336355d3f0ee9766a2cf3be8e4b1ce';
|
|
|
|
const blockTxid = await blocks.getBlockTxid({ hash, index: 218 });
|
|
console.log(blockTxid);
|
|
```
|
|
|
|
### **Get Block Raw**
|
|
|
|
Returns the raw block representation in binary.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} hash
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const hash = '000000000000000015dc777b3ff2611091336355d3f0ee9766a2cf3be8e4b1ce';
|
|
|
|
const blockRaw = await blocks.getBlockRaw({ hash });
|
|
console.log(blockRaw);
|
|
```
|
|
|
|
### **Get Blocks Header**
|
|
|
|
Returns the hex-encoded block header.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} hash
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const blockHeader = await blocks.getBlockHeader({ hash: '0000000000000000000065bda8f8a88f2e1e00d9a6887a43d640e52a4c7660f2' });
|
|
console.log(blockHeader);
|
|
```
|
|
|
|
### **Get Blocks Height**
|
|
|
|
Returns the hash of the block currently at `:height`.
|
|
|
|
**Parameters:**
|
|
|
|
- {number} height
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const blockHeight = await blocks.getBlockHeight({ height: 0 });
|
|
console.log(blockHeight);
|
|
```
|
|
|
|
### **Get Blocks**
|
|
|
|
Returns the 10 newest blocks starting at the tip or at `:start_height` if specified.
|
|
|
|
**Parameters:**
|
|
|
|
- {number} params.start_height
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const getBlocks = await blocks.getBlocks({ start_height: 9999 });
|
|
console.log(getBlocks);
|
|
```
|
|
|
|
### **Get Blocks Tip Height**
|
|
|
|
Returns the 10 newest blocks starting at the tip or at `:start_height` if specified.
|
|
|
|
**Parameters:**
|
|
|
|
- {number} params.start_height
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const blocksTipHeight = await blocks.getBlocksTipHeight();
|
|
console.log(blocksTipHeight);
|
|
```
|
|
|
|
### **Get Blocks Tip Hash**
|
|
|
|
Returns the hash of the last block.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/blocks.ts) ] [ [HTML Example](examples/html/bitcoin/blocks.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { blocks },
|
|
} = mempoolJS();
|
|
|
|
const blocksTipHash = await blocks.getBlocksTipHash();
|
|
console.log(blocksTipHash);
|
|
```
|
|
|
|
### **Get Difficulty Adjustment**
|
|
|
|
Returns the hash of the last block.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/difficulty.ts) ] [ [HTML Example](examples/html/bitcoin/difficulty.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { difficulty },
|
|
} = mempoolJS();
|
|
|
|
const difficultyAdjustment = await difficulty.getDifficultyAdjustment();
|
|
console.log(difficultyAdjustment);
|
|
```
|
|
|
|
### **Get Fees Recommended**
|
|
|
|
Returns our currently suggested fees for new transactions.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/fees.ts) ] [ [HTML Example](examples/html/bitcoin/fees.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { fees },
|
|
} = mempoolJS();
|
|
|
|
const feesRecommended = await fees.getFeesRecommended();
|
|
console.log(feesRecommended);
|
|
```
|
|
|
|
### **Get Fees Mempool Blocks**
|
|
|
|
Returns current mempool as projected blocks.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/fees.ts) ] [ [HTML Example](examples/html/bitcoin/fees.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { fees },
|
|
} = mempoolJS();
|
|
|
|
const feesMempoolBlocks = await fees.getFeesMempoolBlocks();
|
|
console.log(feesMempoolBlocks);
|
|
```
|
|
|
|
### **Get Children Pay for Parent**
|
|
|
|
Returns current mempool as projected blocks.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/fees.ts) ] [ [HTML Example](examples/html/bitcoin/fees.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { fees },
|
|
} = mempoolJS();
|
|
const txid = 'txid';
|
|
|
|
const feesCPFP = await fees.getCPFP({ txid });
|
|
console.log(feesCPFP);
|
|
```
|
|
|
|
### **Get Mempool**
|
|
|
|
Returns current mempool backlog statistics.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/mempool.ts) ] [ [HTML Example](examples/html/bitcoin/mempool.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { mempool },
|
|
} = mempoolJS();
|
|
|
|
const getMempool = await mempool.getMempool();
|
|
console.log(getMempool);
|
|
```
|
|
|
|
### **Get 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`.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/mempool.ts) ] [ [HTML Example](examples/html/bitcoin/mempool.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { mempool },
|
|
} = mempoolJS();
|
|
|
|
const getMempoolRecent = await mempool.getMempoolRecent();
|
|
console.log(getMempoolRecent);
|
|
```
|
|
|
|
### **Get 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.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/mempool.ts) ] [ [HTML Example](examples/html/bitcoin/mempool.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { mempool },
|
|
} = mempoolJS();
|
|
|
|
const getMempoolTxids = await mempool.getMempoolTxids();
|
|
console.log(getMempoolTxids);
|
|
```
|
|
|
|
### **Get Tx**
|
|
|
|
Returns details about a transaction. Available fields: `txid`, `version`, `locktime`, `size`, `weight`, `fee`, `vin`, `vout`, and `status`.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const tx = await transactions.getTx({ txid });
|
|
console.log(tx);
|
|
```
|
|
|
|
### **Get Tx Status**
|
|
|
|
Returns the confirmation status of a transaction. Available fields: `confirmed` (boolean), `block_height` (optional), and `block_hash` (optional).
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txStatus = await transactions.getTxStatus({ txid });
|
|
console.log(txStatus);
|
|
```
|
|
|
|
### **Get Tx Hex**
|
|
|
|
Returns a transaction serialized as hex.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txHex = await transactions.getTxHex({ txid });
|
|
console.log(txHex);
|
|
```
|
|
|
|
### **Get Tx Raw**
|
|
|
|
Returns a transaction as binary data.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txRaw = await transactions.getTxRaw({ txid });
|
|
console.log(txRaw);
|
|
```
|
|
|
|
### **Get Tx Merkle Block Proof**
|
|
|
|
Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txMerkleBlockProof = await transactions.getTxMerkleBlockProof({ txid });
|
|
console.log(txMerkleBlockProof);
|
|
```
|
|
|
|
### **Get Tx Merkle Proof**
|
|
|
|
Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txMerkleProof = await transactions.getTxMerkleProof({ txid });
|
|
console.log(txMerkleProof);
|
|
```
|
|
|
|
### **Get Tx Outspend**
|
|
|
|
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).
|
|
|
|
**Parameters:**
|
|
|
|
- {string} params.txid
|
|
- {number} params.vout
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txOutspend = await transactions.getTxOutspend({
|
|
txid,
|
|
vout: 3,
|
|
});
|
|
console.log(txOutspend);
|
|
```
|
|
|
|
### **Get Tx Outspends**
|
|
|
|
Returns the spending status of all transaction outputs.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const txOutspends = await transactions.getTxOutspends({ txid });
|
|
console.log(txOutspends);
|
|
```
|
|
|
|
### **Post Tx Outspends**
|
|
|
|
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.
|
|
|
|
**Parameters:**
|
|
|
|
- {string} txid
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/transactions.ts) ] [ [HTML Example](examples/html/bitcoin/transactions.html) ] [ [Top](#features) ]
|
|
|
|
```js
|
|
const {
|
|
bitcoin: { transactions },
|
|
} = mempoolJS();
|
|
|
|
const txid = '15e10745f15593a899cef391191bdd3d7c12412cc4696b7bcb669d0feadc8521';
|
|
|
|
const postTx = await transactions.postTx({ txid });
|
|
console.log(postTx);
|
|
```
|
|
|
|
### **Websocket**
|
|
|
|
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.
|
|
|
|
[ [NodeJS Example](examples/nodejs/bitcoin/websocket.ts) ] [ [HTML Example](examples/html/bitcoin/websocket.html) ] [ [Top](#features) ]
|
|
|
|
#### **Websocket Server**
|
|
|
|
Only use on server side apps.
|
|
|
|
```js
|
|
const { bitcoin: { websocket } } = mempoolJS();
|
|
|
|
const init = async () => {
|
|
|
|
const ws = websocket.initServer({
|
|
options: ["blocks", "stats", "mempool-blocks", "live-2h-chart"],
|
|
});
|
|
|
|
ws.on("message", function incoming(data) {
|
|
const res = JSON.parse(data.toString());
|
|
if (res.blocks) {
|
|
console.log(res.blocks);
|
|
}
|
|
if (res.mempoolInfo) {
|
|
console.log(res.mempoolInfo);
|
|
}
|
|
if (res.transactions) {
|
|
console.log(res.transactions);
|
|
}
|
|
if (res.mempoolBlocks) {
|
|
console.log(res.mempoolBlocks);
|
|
}
|
|
});
|
|
}
|
|
init();
|
|
```
|
|
|
|
#### **Websocket Client**
|
|
|
|
Only use on browser apps.
|
|
|
|
```js
|
|
const init = async () => {
|
|
const {
|
|
bitcoin: { websocket },
|
|
} = mempoolJS();
|
|
|
|
const ws = websocket.initClient({
|
|
options: ['blocks', 'stats', 'mempool-blocks', 'live-2h-chart'],
|
|
});
|
|
|
|
ws.addEventListener('message', function incoming({data}) {
|
|
const res = JSON.parse(data.toString());
|
|
if (res.blocks) {
|
|
console.log(res.blocks);
|
|
}
|
|
if (res.mempoolInfo) {
|
|
console.log(res.mempoolInfo);
|
|
}
|
|
if (res.transactions) {
|
|
console.log(res.transactions);
|
|
}
|
|
if (res.mempoolBlocks) {
|
|
console.log(res.mempoolBlocks);
|
|
}
|
|
});
|
|
};
|
|
init();
|
|
```
|