NPM package module for Mempool APIs.
Documentation: https://mempool.space/api
Install the npm module.
# npm
$ npm install @mempool/mempool.js --save
# yarn
$ yarn add @mempool/mempool.jsOr if you're not into package management, just download a ZIP file.
Import the module.
import mempoolJS from '@mempool/mempool.js';
// default mempool.space endpointsconst { bitcoin, liquid } = mempoolJS();
// (optional) your custom endpoints
const { bitcoin } = mempoolJS({
protocol: 'https', // optional, defaults to http for localhost, otherwise https
hostname: 'mempool.space',
network: 'testnet' // 'signet' | 'testnet' | 'mainnet',
config: { // optional axios request config to add to requests
headers: {
authorization: 'Basic auth'
}
}
});
// Liquid API
const { liquid } = mempoolJS({
protocol: 'https', // optional, defaults to http for localhost, otherwise https
hostname: 'liquid.network',
network: 'liquid' // 'liquid' | 'liquidtestnet'
});Include the line below in the head tag of your html file.
<script type="text/javascript" src="https://mempool.space/mempool.js"></script>Call mempoolJS() function to access the API methods.
// default mempool.space endpoints
const { bitcoin } = mempoolJS();
// (optional) your custom endpoints
const { bitcoin } = mempoolJS({
protocol: 'https', // optional, defaults to http for localhost, otherwise https
hostname: 'mempool.space',
network: 'testnet', // 'signet' | 'testnet' | 'mainnet'
});
// Liquid API
const { liquid } = mempoolJS({
protocol: 'https', // optional, defaults to http for localhost, otherwise https
hostname: 'liquid.network',
network: 'liquid' // 'liquid' | 'liquidtestnet'
});Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.