hitbtc-saurox-api

1.0.0 • Public • Published

hitbtc-api

HitBTC API Wrapper

Installation

npm install hitbtc-api

Example usage:

import HitBTC from 'hitbtc-api';
 
const restClient = new HitBTC({ key, secret, isDemo: false });
const websocketClient =
  new HitBTC.WebsocketClient({ key, secret, isDemo: false });
 
restClient.getOrderBook('BTCUSD')
  .then(console.log)
  .catch(console.error);
 
websocketClient.addMarketMessageListener(data => {
  if (data.MarketDataSnapshotFullRefresh) console.log(data);
});
 
// The methods are bound properly, so feel free to destructure them:
const { getMyBalance } = restClient;
getMyBalance()
  .then(({ balance }) => console.log(
    `My USD balance is ${balance.USD.cash}!`
  ))

API

REST

All methods return promises.

  • getTimestamp()
  • getSymbols()
  • getTicker(symbol)
  • getAllTickers()
  • getOrderBook(symbol)
  • getTrades(symbol, params = {})
  • getRecentTrades(symbol, params = {})
  • getMyBalance()
  • getMyActiveOrders(params = {})
  • placeOrder(params = {})
  • cancelOrder(params = {})
  • cancelAllOrders(params = {})
  • getMyRecentOrders(params = {})
  • getMyOrder(params = {})
  • getMyTradesByOrder(params = {})
  • getAllMyTrades(params = {})

WebSocket

  • addMarketMessageListener(listener)
  • addTradingMessageListener(listener)
  • removeMarketMessageListener(listener)
  • removeTradingMessageListener(listener)
  • addMarketListener(event, listener)
  • addTradingListener(event, listener)
  • removeMarketListener(event, listener)
  • removeTradingListener(event, listener)

Readme

Keywords

none

Package Sidebar

Install

npm i hitbtc-saurox-api

Weekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

126 kB

Total Files

8

Last publish

Collaborators

  • saurox