Socket
Socket
Sign inDemoInstall

bisq-js

Package Overview
Dependencies
3
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    bisq-js

NPM Package for Bisq.network API.


Version published
Weekly downloads
2
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Bisq Network JS - API

npm version NPM Known Vulnerabilities License: MIT


Easy way to add Bisq Network API to your JS application.


Donate

Help me to stack sats! :blush:

bc1qn6d6g8ln5zppnh0k70sgmr745td7j2xsgw7elm

Or donate via Lightning Network!


Features


Installation

Using npm:

$ npm install bisq-js

Using yarn:

$ yarn add bisq-js

Usage

Get Currencies

Provides list of available currencies for a given base currency.

[ Example ] [ Top ]

import bisq from 'bisq-js';

const currencies = await bisq.getCurrencies();
console.log(currencies);

Get Depth

Provides list of open offer prices for a single market.

[ Example ] [ Top ]

import bisq from 'bisq-js';

const depth = await bisq.getDepth();
console.log(depth);

Get HLOC

Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.

[ Example ] [ Top ]

import bisq from 'bisq-js';

const hloc = await bisq.getHloc({ market: 'xmr_btc' });
console.log(hloc);

Get Markets

Provides list of available markets.

[ Example ] [ Top ]

import bisq from 'bisq-js';

const markets = await bisq.getMarkets();
console.log(markets);

Get Offers

Provides list of open offer details for a single market.

[ Example ] [ Top ]

import bisq from 'bisq-js';

const offers = await bisq.getOffers({ market: 'xmr_btc' });
console.log(offers);

Get Ticker

Provides 24 hour price ticker for single market or all markets

[ Example ] [ Top ]

import bisq from 'bisq-js';

const ticker = await bisq.getTicker();
console.log(ticker);

Get Trades

Provides 24 hour price ticker for single market or all markets

[ Example ] [ Top ]

import bisq from 'bisq-js';

const trades = await bisq.getTrades({ market: 'xmr_btc' });
console.log(trades);

Get Volumes

Provides periodic volume data in terms of base currency for one or all markets.

[ Example ] [ Top ]

import bisq from 'bisq-js';

const volumes = await bisq.getVolumes();
console.log(volumes);

References


Contributing

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


License MIT

Keywords

FAQs

Last updated on 14 Feb 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc