@dripjs/bitmex
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.0 • Public • Published

    @dripjs/bitmex

    dripjs bitmex api wapper, support for rest api and websocket

    NPM Version Package License NPM Downloads Tiavis Coverage Gitter

    Install

    npm install @dripjs/bitmex

    Use

    require

    var bitmex = require('@dripjs/bitmex');
    
    var bitmexWS = new bitmex.BitmexWS({
      apiKey: `apiKey`,
      apiSecret: `apiSecret`,
      testnet: true,
    });
    bitmexWS.orderbook$('XBTUSD').subscribe((orderbook) => {
      console.log(orderbook);
    });

    import

    import { BitmexWS, BitmexRest } from '@dripjs/bitmex';
    
    const bitmexWS = new BitmexWS({
      apiKey: `apiKey`,
      apiSecret: `apiSecret`,
      testnet: true,
    });
    bitmexWS.orderbook$('XBTUSD').subscribe((orderbook) => {
      console.log(orderbook);
    });
    
    const bitmexRest = new BitmexRest({
      apiKey: `apiKey`,
      apiSecret: `apiSecret`,
      testnet: true,
    });
    bitmexRest
      .fetchOrderbook({
        symbol: 'XBTUSD',
        depth: 5,
      })
      .then((orderbook) => {
        console.log(orderbook);
      });

    The orderbook$ output as

    {
      asks: [["3911", "176809"], ["3911.5", "627"], ["3912", "12786"], ["3912.5", "393"], ["3913", "2213"], ],
      bids: [["3910.5", "27665"], ["3910", "14421"], ["3909.5", "8052"], ["3909", "1765"], ["3908.5", "2958"], ]
    }

    BitmexWS API

    Method Return Description
    orderbook$(pair: string) Observable<OrderbookL2Response> realtime orderbook
    stopOrderbook(pair: string) void stop realtime orderbook
    trade$(pair: string) Observable<TradeResponse> realtime trade
    stopTrade(pair: string) void stop realtime trade
    tradeBin1d$(pair: string) Observable<TradeResponse> realtime 1-day trade bins
    stopTradeBin1d(pair: string) void stop realtime 1-day trade bins
    quote$(pair: string) Observable<QuoteResponse> realtime quote
    stopQuote(pair: string) void stop realtime quote
    settlement$(pair: string) Observable<SettlementResponse> realtime settlement
    stopSettlement(pair: string) void stop realtime settlement
    order$(pair: string) Observable<OrderResponse> realtime order
    stopOrder(pair: string) void stop realtime order
    destroy() void close websocket connection

    BitmexRest API

    Method Return Description
    createOrder(request: Partial<RestOrderRequest>) Promise<RestOrderResponse>
    fetchOrder(request: Partial<RestFetchOrderRequest>): Promise<RestOrderResponse>
    updateOrder(request: Partial<RestOrderRequest>) Promise<RestOrderResponse>
    cancelOrder(request: Partial<RestOrderRequest>) Promise<RestOrderResponse>
    fetchOrderbook(request: RestOrderbookRequest) Promise<RestOrderbookL2Response>
    fetchInstrument() Promise<RestInstrumentResponse>
    fetchBar(request: RestBarRequest) Promise<RestBarResponse>

    api docs

    see https://drip-trader.github.io/dripjs-docs

    Install

    npm i @dripjs/bitmex

    DownloadsWeekly Downloads

    4

    Version

    0.2.0

    License

    GPL-3.0-or-later

    Unpacked Size

    95 kB

    Total Files

    151

    Last publish

    Collaborators

    • zlq4863947