Miguel Medeiros c80f82a0b1

* FIX: getBlocks optional params

* v2.3.0 - new minor version for mempool-js
- Add support for Bisq API
- Add support for Liquid API
- Change the main object to export network objects.
- Change README.md instructions.

Co-authored-by: softsimon <softsimon@users.noreply.github.com>

2021-04-14 17:27:28 -03:00

2.9 KiB

Raw Blame History

Mempool JS API

NPM package module for Mempool APIs.

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

Bitcoin
Bisq
Liquid
- Addresses
- Assets
- Blocks
- Fees
- Mempool
- Transactions
- Websocket Client
- Websocket Server

Contributing

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

2.9 KiB Raw Blame History