Skip to content

Repository files navigation

Mempool JS API

npm versionNPMKnown VulnerabilitiesLicense: MIT

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.

importmempoolJSfrom'@mempool/mempool.js';// default mempool.space endpointsconst { bitcoin, liquid } = mempoolJS();// (optional) your custom endpointsconst{ bitcoin }=mempoolJS({protocol: 'https',// optional, defaults to http for localhost, otherwise httpshostname: 'mempool.space',network: 'testnet4'// 'signet' | 'testnet' | 'testnet4' | 'mainnet',config: {// optional axios request config to add to requestsheaders: {authorization: 'Basic auth'}}});// Liquid APIconst{ liquid }=mempoolJS({protocol: 'https',// optional, defaults to http for localhost, otherwise httpshostname: 'liquid.network',network: 'liquid'// 'liquid' | 'liquidtestnet'});

CommonJS

Include the line below in the head tag of your html file.

<scripttype="text/javascript" src="https://mempool.space/mempool.js"></script>

Call mempoolJS() function to access the API methods.

// default mempool.space endpointsconst{ bitcoin }=mempoolJS();// (optional) your custom endpointsconst{ bitcoin }=mempoolJS({protocol: 'https',// optional, defaults to http for localhost, otherwise httpshostname: 'mempool.space',network: 'testnet4',// 'signet' | 'testnet' | 'testnet4' | 'mainnet'});// Liquid APIconst{ liquid }=mempoolJS({protocol: 'https',// optional, defaults to http for localhost, otherwise httpshostname: 'liquid.network',network: 'liquid'// 'liquid' | 'liquidtestnet'});

Features


Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.


LicenseMIT

About

NPM Package for Mempool.Space API.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages