Skip to content

OrderBookApi.md

Latest commit

 

History

History
104 lines (70 loc) · 2.94 KB

OrderBookApi.md

File metadata and controls

104 lines (70 loc) · 2.94 KB
Raw

BitMexApi.OrderBookApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
orderBookGet GET /orderBook Get current orderbook [deprecated, use /orderBook/L2].
orderBookGetL2 GET /orderBook/L2 Get current orderbook in vertical format.

orderBookGet

[OrderBook] orderBookGet(symbol, opts)

Get current orderbook [deprecated, use /orderBook/L2].

Example

import BitMexApi from 'bit_mex_api';

let apiInstance = new BitMexApi.OrderBookApi();

let symbol = "symbol_example"; // String | Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.

let opts = { 
  'depth': 25 // Number | Orderbook depth.
};

apiInstance.orderBookGet(symbol, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
symbol String Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.
depth Number Orderbook depth. [optional] [default to 25]

Return type

[OrderBook]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

orderBookGetL2

[OrderBookL2] orderBookGetL2(symbol, opts)

Get current orderbook in vertical format.

Example

import BitMexApi from 'bit_mex_api';

let apiInstance = new BitMexApi.OrderBookApi();

let symbol = "symbol_example"; // String | Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.

let opts = { 
  'depth': 25 // Number | Orderbook depth per side. Send 0 for full depth.
};

apiInstance.orderBookGetL2(symbol, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
symbol String Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.
depth Number Orderbook depth per side. Send 0 for full depth. [optional] [default to 25]

Return type

[OrderBookL2]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript