mempool/README.md
2021-04-17 00:20:32 -03:00

3.0 KiB

Mempool JS API

npm version NPM Known Vulnerabilities License: MIT

NPM package module for Mempool APIs.

Documentation: https://mempool.tools/mempool-js


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();

// (alternative) your custom endpoints
const { bitcoin, bisq, liquid } = mempoolJS({
  homespace: 'mempool.space',
});

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();

// (alternative) your custom endpoints
const { bitcoin, bisq, liquid } = mempoolJS({
  homespace: 'mempool.space',
});

Features


Contributing

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


License MIT