[BREAKGLASS] NPM Package for Mempool.Space API.
Go to file
2021-04-17 00:19:46 -03:00
dist - Add mempool.js link to all examples. 2021-04-10 12:30:24 -03:00
examples v2.3.0 (#12) 2021-04-14 17:27:28 -03:00
src v2.3.0 (#12) 2021-04-14 17:27:28 -03:00
.editorconfig Init 2021-02-08 16:54:37 -03:00
.eslintrc.js Init 2021-02-08 16:54:37 -03:00
.gitignore - Add mempool.js link to all examples. 2021-04-10 12:30:24 -03:00
.prettierrc Init 2021-02-08 16:54:37 -03:00
LICENSE v2.2.0 - new major version for mempool-js (#2) 2021-04-08 10:15:30 -03:00
nodemon.json Init 2021-02-08 16:54:37 -03:00
package.json FIX rename package name. (#19) 2021-04-17 00:19:46 -03:00
README-bisq.md v2.3.0 (#12) 2021-04-14 17:27:28 -03:00
README-bitcoin.md v2.3.0 (#12) 2021-04-14 17:27:28 -03:00
README-liquid.md v2.3.0 (#12) 2021-04-14 17:27:28 -03:00
README.md FIX rename package name. (#19) 2021-04-17 00:19:46 -03:00
tsconfig.json v2.2.0 - new major version for mempool-js (#2) 2021-04-08 10:15:30 -03:00
yarn.lock v2.2.0 - new major version for mempool-js (#2) 2021-04-08 10:15:30 -03:00

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