Skip to content

Get Rank Config V3

GET
/rank/v3/rank/{rank_id}

Get rank configuration for specific rank id

Required Permissions: rank:read:config

Authorizations

Parameters

Path Parameters

rank_id
required
string
>= 1 characters

Responses

200

Successful Response

Response to successfully requesting all rank config

object
rank_configs
required

List of rank configurations

Array<object>

Configuration about a specific rank type

object
name

Human readable name for this rank

string
description

Description of this rank

string
custom_data

Custom data about this rank

object
key
additional properties
string
>= 1 characters <= 4096 characters
max_mu
required

The maximum mu value achievable. Any attempts to update a rank value to be higher than this get clamped to the maximum

number
min_mu
required

The minimum mu value achievable. Any attempts to update a rank value to be lower than this get clamped to the minimum

number
min_sigma
required

The minimum sigma allowed. Any attempts to update variance to be lower than this get clamped to the minimum

number
>= 2
beta

The distance between skill ranks that yields ~76% chance of winning. Recommended value is half the default variance

number
default_mu
required

The default mu value for this rank id. Will be used when players do not have any rank history

number
default_sigma
required

The default sigma for this rank id. Will be used when players do not have any rank history

number
>= 2
draw_probability

The percent probability of a draw occuring in the game. Must be in [0, 1)

number
<= 1
tau

Factor that determines how quickly a player’s variance is adjusted. A larger tau will result in more volatile in ranks. Recommended value is is (default_sigma * .01)

number
rank_id
required

ID for this rank type

string
>= 1 characters

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string