Skip to content

LeaderboardApi.md

Latest commit

 

History

History
112 lines (79 loc) · 3.22 KB

LeaderboardApi.md

File metadata and controls

112 lines (79 loc) · 3.22 KB

BitMexApi.LeaderboardApi

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

Method HTTP request Description
leaderboardGet GET /leaderboard Get current leaderboard.
leaderboardGetName GET /leaderboard/name Get your alias on the leaderboard.

leaderboardGet

[Leaderboard] leaderboardGet(opts)

Get current leaderboard.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.LeaderboardApi();

var opts = { 
  'method': "notional" // String | Ranking type. Options: \"notional\", \"ROE\"
};

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

Parameters

Name Type Description Notes
method String Ranking type. Options: "notional", "ROE" [optional] [default to notional]

Return type

[Leaderboard]

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

leaderboardGetName

InlineResponse2001 leaderboardGetName()

Get your alias on the leaderboard.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiNonce
var apiNonce = defaultClient.authentications['apiNonce'];
apiNonce.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiNonce.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.LeaderboardApi();

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

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2001

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

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