Mempool JS API
NPM package module for Mempool APIs.
Documentation: https://mempool.space/api
Installation
ES Modules
Install the npm module.
# npm
$ npm install @mempool/mempool.js --save
# yarn
$ yarn add @mempool/mempool.js
Or if you're not into package management, just download a ZIP file.
Import the module.
import mempoolJS from '@mempool/mempool.js';
// default mempool.space endpoints
const { bitcoin, bisq, liquid } = mempoolJS();
// (optional) your custom endpoints
const { bitcoin, bisq, liquid } = mempoolJS({
hostname: 'mempool.space',
network: 'testnet' // 'signet' | 'testnet' | 'mainnet'
});
CommonJS
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, bisq, liquid } = mempoolJS();
// (optional) your custom endpoints
const { bitcoin, bisq, liquid } = mempoolJS({
hostname: 'mempool.space',
network: 'testnet' // 'signet' | 'testnet' | 'mainnet'
});
Features
Contributing
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.