Skip to content

Get Rank Config

Deprecated
GET
/rank/v1/rank/{rank_id}

Get rank configuration for specific rank id

Required Permissions: rank:read:config DEPRECATED Use V2 endpoint instead

Authorizations

Parameters

Path Parameters

rank_id
required
integer
>= 1

Responses

200

Successful Response

DEPRECATED Response to successfully requesting all rank config

object
rank_configs
required

List of rank configurations

Array<object>

DEPRECATED Configuration about a specific rank type

object
rank_id
required

ID for this rank type

integer
>= 1
default_rank
required

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

number
default_variance
required

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

number
>= 2
max_rank_allowed
required

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

number
min_rank_allowed
required

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

number
min_variance_allowed
required

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

number
>= 2
trueskill_beta

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

number
trueskill_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_variance * .01)

number
trueskill_draw_probability

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

number
<= 1

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