LeaderboardApi.md

SwaggerClient::LeaderboardApi

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

Method	HTTP request	Description
leaderboard_get	GET /leaderboard	Get current leaderboard.
leaderboard_get_name	GET /leaderboard/name	Get your alias on the leaderboard.

leaderboard_get

Array<Leaderboard> leaderboard_get(opts)

Get current leaderboard.

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::LeaderboardApi.new

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

begin
  #Get current leaderboard.
  result = api_instance.leaderboard_get(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling LeaderboardApi->leaderboard_get: #{e}"
end

Parameters

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

Return type

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

leaderboard_get_name

InlineResponse2001 leaderboard_get_name

Get your alias on the leaderboard.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: apiNonce
  config.api_key['api-nonce'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-nonce'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['api-signature'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-signature'] = 'Bearer'
end

api_instance = SwaggerClient::LeaderboardApi.new

begin
  #Get your alias on the leaderboard.
  result = api_instance.leaderboard_get_name
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling LeaderboardApi->leaderboard_get_name: #{e}"
end

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