[BREAKGLASS] NPM Package for Mempool.Space API.
Go to file
2022-01-29 07:02:03 +00:00
dist - Add mempool.js link to all examples. 2021-04-10 12:30:24 -03:00
examples Correcting "blocks" typo 2021-12-20 23:14:11 +04:00
npm-bisq-js Change version to 2.2.1 for bisq / liquid modules. 2021-08-10 12:39:11 -03:00
npm-liquid-js Add liquid.js documentation. 2021-08-10 13:03:23 -03:00
src Updating endpoint addresses for Liquid and Bisq backend 2021-12-20 23:34:52 +04:00
.editorconfig Init 2021-02-08 16:54:37 -03:00
.eslintrc.js Init 2021-02-08 16:54:37 -03:00
.gitignore Bugfix Websocket hostname. (#21) 2021-05-20 12:03:40 -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 Add bisqJS and liquidJS npm modules. 2021-08-10 01:30:13 -03:00
package-lock.json Bumping dependency versions and package version to 2.2.4 2021-12-20 22:25:12 +04:00
package.json Bumping version to 2.3.0 2022-01-10 15:53:10 +04:00
README-bisq.md Add liquid.js documentation. 2021-08-10 13:03:23 -03:00
README-bitcoin.md Merge pull request #30 from Draichi/patch-1 2021-12-08 21:36:58 +04:00
README-liquid.md Adding support for Asset Icon API endpoints 2021-12-20 23:25:44 +04:00
README.md Test 2022-01-29 07:02:03 +00:00
tsconfig.json v2.2.0 - new major version for mempool-js (#2) 2021-04-08 10:15:30 -03:00
yarn.lock Bumping dependency versions and package version to 2.2.4 2021-12-20 22:25:12 +04:00

Mempool JS API

npm version NPM Known Vulnerabilities License: 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.

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.


License MIT