Skip to content

Latest commit

 

History

History
137 lines (105 loc) · 4.34 KB

LeaderboardApi.md

File metadata and controls

137 lines (105 loc) · 4.34 KB

IO.Swagger.Api.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 LeaderboardGet (string method = null)

Get current leaderboard.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class LeaderboardGetExample
    {
        public void main()
        {
            var apiInstance = new LeaderboardApi();
            var method = method_example;  // string | Ranking type. Options: \"notional\", \"ROE\" (optional)  (default to notional)

            try
            {
                // Get current leaderboard.
                List<Leaderboard> result = apiInstance.LeaderboardGet(method);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LeaderboardApi.LeaderboardGet: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

List

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 ()

Get your alias on the leaderboard.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class LeaderboardGetNameExample
    {
        public void main()
        {
            // Configure API key authorization: apiExpires
            Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
            // Configure API key authorization: apiKey
            Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
            // Configure API key authorization: apiSignature
            Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");

            var apiInstance = new LeaderboardApi();

            try
            {
                // Get your alias on the leaderboard.
                InlineResponse200 result = apiInstance.LeaderboardGetName();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LeaderboardApi.LeaderboardGetName: " + e.Message );
            }
        }
    }
}

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]