@pxtrn/bybit-api

An unofficial node.js lowlevel wrapper for the Bybit Cryptocurrency Derivative exchange API.

Installation

npm install --save @pxtrn/bybit-api

Usage

Create API credentials at bybit (obviously you need to be logged in):

• Livenet
• Testnet

Rest client

1const {RestClient} = require('@pxtrn/bybit-api');
2
3const API_KEY = 'xxx';
4const PRIVATE_KEY = 'yyy';
5
6const client = new RestClient(API_KEY, PRIVATE_KEY);
7
8client.changeUserLeverage({leverage: 4, symbol: 'ETHUSD'})
9  .then(result => {
10    console.log(result);
11  })
12  .catch(err => {
13    console.error(error);
14  });

See rest client api docs for further information.

Websocket client

1const {WebsocketClient} = require('@pxtrn/bybit-api');
2
3const API_KEY = 'xxx';
4const PRIVATE_KEY = 'yyy';
5
6const ws = new WebsocketClient({key: API_KEY, secret: PRIVATE_KEY});
7
8ws.subscribe(['position', 'execution', 'trade']);
9ws.subscribe('kline.BTCUSD.1m');
10
11ws.on('open', function() {
12  console.log('connection open');
13});
14
15ws.on('update', function(message) {
16  console.log('update', message);
17});
18
19ws.on('response', function(response) {
20  console.log('response', response);
21});
22
23ws.on('close', function() {
24  console.log('connection closed');
25});
26
27ws.on('error', function(err) {
28  console.error('ERR', err);
29});

See websocket client api docs for further information.

Customise Logging

Pass a custom logger which supports the log methods silly, debug, notice, info, warning and error, or override methods from the default logger as desired:

1const { RestClient, WebsocketClient, DefaultLogger } = require('@pxtrn/bybit-api');
2
3// Disable all logging on the silly level
4DefaultLogger.silly = () => {};
5
6const API_KEY = 'xxx';
7const PRIVATE_KEY = 'yyy';
8
9const ws = new WebsocketClient({key: API_KEY, secret: PRIVATE_KEY}, DefaultLogger);

Donations

If this library helps you to trade better on bybit, feel free to donate a coffee, or create a bybit account using my ref link.

• BTC 1Fh1158pXXudfM6ZrPJJMR7Y5SgZUz4EdF
• ETH 0x21aEdeC53ab7593b77C9558942f0c9E78131e8d7
• LTC LNdHSVtG6UWsriMYLJR3qLdfVNKwJ6GSLF