Skip to main content

Calculate V3 Ranks

POST 
/rank/v3/rank:calculate

Calculate a rank update on players and return the results without persisting them Requires at least two teams, the players' ranks before the last match was played, and parameters on how to calculate the rank changes

Required Permissions:

  • For any player (including themselves) any of: rank:*, rank:calculate

Request​

Body

required

    match_length_seconds Match Length Seconds (integer)required

    How many seconds the match lasted

    teams

    object[]

    required

    List of teams that participated in this match

  • Array [

    • players

    object[]

    required

    List of CalculatedRank objects that give stats about a specific player from the match

  • Array [

    • player_uuid uuidrequired

    UUID for this specific player

    rank

    object

    required

    Ranked data about a player's skill and confidence levels

    mu Mu (number)required

    A measure of perceived skill in a player

    sigma Sigma (number)required

    A measure of how confident we are in the perceived skill (high sigma means low confidence)

    custom_data

    object

    Custom key-value player rank data

    property name* string
    seconds_in_match Seconds In Match (integer)required

    How many seconds this player was in the match

  • ]

    • team_rank Team Rank (integer)required

    Possible values: >= 1

    What rank this team came in. 1 indicates victory, and higher values are placements. Matching ranks indicate draws

  • ]

    • rank_config

    object

    required

    Config about how to recalculate ranks

    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)

Responses​

Successful Response

Schema

    updated_players

    object[]

    required

    List of players and their updated ranks

  • Array [

    • player_uuid uuidrequired

    UUID for this specific player

    rank

    object

    required

    Ranked data about a player's skill and confidence levels

    mu Mu (number)required

    A measure of perceived skill in a player

    sigma Sigma (number)required

    A measure of how confident we are in the perceived skill (high sigma means low confidence)

    custom_data

    object

    Custom key-value player rank data

    property name* string

  • ]

Loading...