Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.65 KB

LeaderboardApi.md

File metadata and controls

55 lines (37 loc) · 1.65 KB
Raw

bitmex_client.LeaderboardApi

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

Method HTTP request Description
leaderboard_get GET /leaderboard Get current leaderboard.

leaderboard_get

list[Leaderboard] leaderboard_get(method=method)

Get current leaderboard.

Example

from __future__ import print_function
import time
import bitmex_client
from bitmex_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = bitmex_client.LeaderboardApi()
method = 'notional' # str | Ranking type. Options: \"notional\", \"ROE\" (optional) (default to notional)

try: 
    # Get current leaderboard.
    api_response = api_instance.leaderboard_get(method=method)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LeaderboardApi->leaderboard_get: %s\n" % e)

Parameters

Name Type Description Notes
method str 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]