LeaderboardApi.md

LeaderboardApi

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

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

leaderboardGet

List<Leaderboard> leaderboardGet(method)

Get current leaderboard.

Example

// Import classes:
//import io.swagger.client.api.LeaderboardApi;

LeaderboardApi apiInstance = new LeaderboardApi();
String method = "notional"; // String | Ranking type. Options: \"notional\", \"ROE\"
try {
    List<Leaderboard> result = apiInstance.leaderboardGet(method);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LeaderboardApi#leaderboardGet");
    e.printStackTrace();
}

Parameters

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

Return type

List<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

InlineResponse200 leaderboardGetName()

Get your alias on the leaderboard.

Example

// Import classes:
//import io.swagger.client.api.LeaderboardApi;

LeaderboardApi apiInstance = new LeaderboardApi();
try {
    InlineResponse200 result = apiInstance.leaderboardGetName();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LeaderboardApi#leaderboardGetName");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

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