Back to packageRELEASE DETAILS

2.3.4

npm

@0xflick/mempool.js

NPM package module for Mempool APIs.

Published1 Feb 2024

Direct dependencies13

Transitive dependenciesNot calculated

README

Current package documentation

Mempool JS API

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({
  protocol: 'https', // optional, defaults to http for localhost, otherwise https
  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

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.

License MIT

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 13

Native requirements

13 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
axios Environment { "local_name": "axios", "alias": false, "peer_metadata": null }	`0.24.0`	runtime
ws Environment { "local_name": "ws", "alias": false, "peer_metadata": null }	`8.3.0`	runtime
@types/node Environment { "local_name": "@types/node", "alias": false, "peer_metadata": null }	`^14.14.25`	development
@types/websocket Environment { "local_name": "@types/websocket", "alias": false, "peer_metadata": null }	`^1.0.2`	development
@types/ws Environment { "local_name": "@types/ws", "alias": false, "peer_metadata": null }	`^7.4.1`	development
@typescript-eslint/eslint-plugin Environment { "local_name": "@typescript-eslint/eslint-plugin", "alias": false, "peer_metadata": null }	`^4.14.2`	development
@typescript-eslint/parser Environment { "local_name": "@typescript-eslint/parser", "alias": false, "peer_metadata": null }	`^4.14.2`	development
browserify Environment { "local_name": "browserify", "alias": false, "peer_metadata": null }	`^17.0.0`	development
eslint Environment { "local_name": "eslint", "alias": false, "peer_metadata": null }	`^7.19.0`	development
nodemon Environment { "local_name": "nodemon", "alias": false, "peer_metadata": null }	`^2.0.7`	development
tinyify Environment { "local_name": "tinyify", "alias": false, "peer_metadata": null }	`^3.0.0`	development
ts-node Environment { "local_name": "ts-node", "alias": false, "peer_metadata": null }	`^9.1.1`	development
typescript Environment { "local_name": "typescript", "alias": false, "peer_metadata": null }	`^4.1.3`	development

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "shasum": "2d8db4c44d91680c618e85c3f5612d62317135e0",
  "integrity": "sha512-aoIqxnG0aWtTJBF1A4RLxI7aNKlhlPbGPiUd5yMyt0hOL5GYmCsUbePU11VQ7LpZtl2BLiWsDG1caZyGKnVQhw==",
  "tarball": "https://registry.npmjs.org/@0xflick/mempool.js/-/mempool.js-2.3.4.tgz",
  "fileCount": 101,
  "unpackedSize": 174531,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEYCIQDcnIlv+jq7nU4KxzWwoCyyEWW32tV3srUPEQ8a69apbwIhAJuXiyOlvDaySwgQlDISWAT6H0SU80e5popEuYnGIpxa"
    }
  ]
}