GetRankings

Request

GET https://api.brawlhalla.com/v1/leaderboard/ranked

Usage

This request returns information from the ranked leaderboards.

Parameters

Parameter	Type	Required	Description
page	Integer	❌	The page to return data from.
max_results	Integer	❌	The maximum number of results one page can have. The maximum this value can be is 50. If omitted, defaults to 10.
game_mode	String	✔️	The game mode to return data from. Accepts 1v1, 2v2, and 3v3.
region	String	✔️	The region to return data from. ALL returns data from every region. Otherwise, accepted values are US-E, EU, SEA, BRZ, AUS, US-W, JPS, SA, and ME.
search	String	❌	The text to search and filter rankings by.
order_by	String	❌	The parameter results will be sorted by. If omitted, defaults to rating.

Order_by Parameters

The allowed order_by options are rating, best_rating, wl_ratio, wins, and games.

Response

{
  "rankings": [
    {
      "players": [
        {
          "id": 4697805,
          "username": "Octavius"
        }
      ],
      "best_rating": 2714,
      "rank": 1,
      "rating": 2714,
      "wins": 693,
      "losses": 64,
      "region": "US-E",
      "tier": "Valhallan"
    },
    {
      "players": [
        {
          "id": 2467374,
          "username": "UpyriDensetsu"
        }
      ],
      "best_rating": 2824,
      "rank": 2,
      "rating": 2653,
      "wins": 1358,
      "losses": 472,
      "region": "BRZ",
      "tier": "Valhallan"
    }
  ],
  "total_pages": 35
}

Response Elements

Element	Type	Required	Description
rankings	Array (Object)	✔️	An array of leaderboard instances. This is a Ranking schema.
total_pages	Integer	✔️	The total number of pages your search obtained.