Bisq Network JS - API

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

• Instalation

• Usage

  • Get Currencies
  • Get Depth
  • Get Hloc
  • Get Markets
  • Get Offers
  • Get Ticker
  • Get Trades
  • Get Volumes

• References

• Donate

• Contribute

• License

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

• Website: https://bisq.network
• API Documentation: https://bisq.markets/api/

Contributing

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

License MIT