Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.34 KB

LeaderboardApi.md

File metadata and controls

65 lines (40 loc) · 2.34 KB

\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

[]Leaderboard LeaderboardGet(ctx, optional) Get current leaderboard.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *LeaderboardApiLeaderboardGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a LeaderboardApiLeaderboardGetOpts struct

Name Type Description Notes
method optional.String Ranking type. Options: "notional", "ROE" [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

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

LeaderboardGetName

InlineResponse200 LeaderboardGetName(ctx, ) Get your alias on the leaderboard.

Required 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

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