Mempool.Space JS API
Easy way to add Mempool API to your JS application.
Features
Installation
Using npm:
$ npm install mempool-space-js
Using yarn:
$ yarn add mempool-space-js
Usage
Get Fees Recommended
Returns our currently suggested fees for new transactions.
import { fees } from './../src/index';
...
const feesRecommended = await fees.getFeesRecommended();
console.log(feesRecommended);
Get Fees Mempool Blocks
Returns current mempool as projected blocks.
import { fees } from './../src/index';
...
const feesMempoolBlocks = await fees.getFeesMempoolBlocks();
console.log(feesMempoolBlocks);
Get Mempool
Returns current mempool backlog statistics.
import { mempool } from './../src/index';
...
const getMempool = await mempool.getMempool();
console.log(getMempool);
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.
import { mempool } from './../src/';
...
const getMempoolTxids = await mempool.getMempoolTxids();
console.log(getMempoolTxids);
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.
import { mempool } from './../src/index';
...
const getMempoolRecent = await mempool.getMempoolRecent();
console.log(getMempoolRecent);
Get Block
Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, and previousblockhash.
Parameters:
- {Object} params - Params object.
- {string} params.hash - Hash from a block
import { blocks } from './../src/index';
...
const block = await blocks.getBlock({
hash: '000000000000000015dc...'
});
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:
- {Object} params - Params object.
- {string} params.hash - Hash from a block
import { blocks } from './../src/index';
...
const blockStatus = await blocks.getBlockStatus({
hash: '000000000000000015dc...'
});
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:
- {Object} params - Params object.
- {string} params.hash - Hash from a block
- {number} params.start_index - Default: 25
import { blocks } from './../src/index';
...
const blockTxs = await blocks.getBlockTxs({
hash: '000000000000000015dc...'
});
console.log(blockTxs);
Get Block Txids
Returns a list of all txids in the block.
Parameters:
- {Object} params - Params object.
- {string} params.hash - Hash from a block
import { blocks } from './../src/index';
...
const blockTxids = await blocks.getBlockTxids({
hash: '000000000000000015dc...'
});
console.log(blockTxids);
Get Block Txid
Returns the transaction at index :index within the specified block.
Parameters:
- {Object} params - Params object.
- {string} params.hash - Hash from a block
- {number} params.index - Index
import { blocks } from './../src/index';
...
const blockTxid = await blocks.getBlockTxid({
hash: '000000000000000015dc...',
index: 218
});
console.log(blockTxids);
Get Block Raw
Returns the raw block representation in binary.
Parameters:
- {Object} params - Params object.
- {string} params.hash - Hash from a block
import { blocks } from './../src/index';
...
const blockRaw = await blocks.getBlockRaw({
hash: '000000000000000015dc...'
});
console.log(blockRaw);
Get Blocks Height
Returns the hash of the block currently at :height.
Parameters:
- {Object} params - Params object.
- {number} params.height - Height from a block
import { blocks } from './../src/index';
...
const blockHeight = await blocks.getBlockHeight({
height: 66666,
});
console.log(blockHeight);
Get Blocks
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
Parameters:
- {Object} params - Params object.
- {number} params.start_height - Height from a block
import { blocks } from './../src/index';
...
const getBlocks = await blocks.getBlocks({
start_height: 66666
});
console.log(getBlocks);
Get Blocks Tip Height
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
Parameters:
- {Object} params - Params object.
- {number} params.start_height - Height from a block
import { blocks } from './../src/index';
...
const blocksTipHeight = await blocks.getBlocksTipHeight();
console.log(blocksTipHeight);
Get Blocks Tip Hash
Returns the hash of the last block.
Parameters:
- {Object} params - Params object.
- {number} params.start_height - Height from a block
import { blocks } from './../src/index';
...
const blocksTipHash = await blocks.getBlocksTipHash();
console.log(blocksTipHash);
Get Tx
Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
Parameters:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const tx = await transactions.getTx({
txid: '15e10745f15593...'
});
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:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txStatus = await transactions.getTxStatus({
txid: '15e10745f15593...'
});
console.log(txStatus);
Get Tx Hex
Returns a transaction serialized as hex.
Parameters:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txHex = await transactions.getTxHex({
txid: '15e10745f15593...'
});
console.log(txHex);
Get Tx Raw
Returns a transaction as binary data.
Parameters:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txRaw = await transactions.getTxRaw({
txid: '15e10745f15593...'
});
console.log(txRaw);
Get Tx Merkle Block Proof
Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
Parameters:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txMerkleBlockProof = await transactions.getTxMerkleBlockProof({
txid: '15e10745f15593...'
});
console.log(txMerkleBlockProof);
Get Tx Merkle Proof
Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
Parameters:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txMerkleProof = await transactions.getTxMerkleProof({
txid: '15e10745f15593...'
});
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:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txOutspend = await transactions.getTxOutspend({
txid: '15e10745f15593...',
vout: 3,
});
console.log(txOutspend);
Get Tx Outspends
Returns the spending status of all transaction outputs.
Parameters:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const txOutspends = await transactions.getTxOutspends({
txid: '15e10745f15593...'
});
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:
- {Object} params - Params object.
- {string} params.txid - Transactions id.
import { transactions } from './../src/index';
...
const postTx = await transactions.postTx({
txid: '15e10745f15593...'
});
console.log(postTx);
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:
- {Object} params - Params object.
- {string} params.address - Address id.
import { addresses } from './../src/index';
...
const addressTest = await addresses.getAddress({
address: '15e10745f15593a...'
});
console.log(addressTest);
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 (see below).
Parameters:
- {Object} params - Params object.
- {string} params.address - Address id.
import { addresses } from './../src/index';
...
const addressTxs = await addresses.getAddressTxs({
address: '15e10745f15593a...'
});
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:
- {Object} params - Params object.
- {string} params.address - Address id.
import { addresses } from './../src/index';
...
const addressTxsChain = await addresses.getAddressTxsChain({
address: '15e10745f15593a...'
});
console.log(addressTxsChain);
Get Address Txs Mempool
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
Parameters:
- {Object} params - Params object.
- {string} params.address - Address id.
import { addresses } from './../src/index';
...
const addressTxsMempool = await addresses.getAddressTxsMempool({
address: '15e10745f15593a...'
});
console.log(addressTxsMempool);
Get Address Txs Utxo
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
Parameters:
- {Object} params - Params object.
- {string} params.address - Address id.
import { addresses } from './../src/index';
...
const addressTxsUtxo = await addresses.getAddressTxsUtxo({
address: '15e10745f15593a...'
});
console.log(addressTxsUtxo);
References
- Mempool.Space Website: https://mempool.space
- Mempool.Sapce API Documentation: https://mempool.space/api
- My Website: https://miguelmedeiros.com
Donate
Help me to stack sats! 😊
bc1q4m9hs4fv3etleyqgp4jhvak0q3w26mmkntqq02
Or donate via Lightning Network!
Contributing
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.