Skip to main content

Get Rank Config V3

GET 
/rank/v3/rank/:rank_id

Get rank configuration for specific rank id

Required Permissions: rank:read:config

Request​

Path Parameters

    rank_id Rank Idrequired

    Possible values: non-empty

Responses​

Successful Response

Schema

    rank_configs

    object[]

    required

    List of rank configurations

  • Array [

    • name Name (string)

    Human readable name for this rank

    description Description (string)

    Description of this rank

    custom_data

    object

    Custom data about this rank

    property name* string
    max_mu Max Mu (number)required

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

    min_mu Min Mu (number)required

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

    min_sigma Min Sigma (number)required

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

    beta Beta (number)

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

    default_mu Default Mu (number)required

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

    default_sigma Default Sigma (number)required

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

    draw_probability Draw Probability (number)

    Possible values: <= 1

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

    tau Tau (number)

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

    rank_id Rank Id (string)required

    Possible values: non-empty

    ID for this rank type

  • ]

Loading...