StatsApi.md

BitMexApi.StatsApi

All URIs are relative to https://www.bitmex.com/api/v1

Method	HTTP request	Description
statsGet	GET /stats	Get exchange-wide and per-series turnover and volume statistics.
statsHistory	GET /stats/history	Get historical exchange-wide and per-series turnover and volume statistics.
statsHistoryUSD	GET /stats/historyUSD	Get a summary of exchange statistics in USD.

statsGet

[Stats] statsGet()

Get exchange-wide and per-series turnover and volume statistics.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.StatsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.statsGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

[Stats]

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

statsHistory

[StatsHistory] statsHistory()

Get historical exchange-wide and per-series turnover and volume statistics.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.StatsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.statsHistory(callback);

Parameters

This endpoint does not need any parameter.

Return type

[StatsHistory]

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

statsHistoryUSD

[StatsUSD] statsHistoryUSD()

Get a summary of exchange statistics in USD.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.StatsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.statsHistoryUSD(callback);

Parameters

This endpoint does not need any parameter.

Return type

[StatsUSD]

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