API:2/pvp/seasons/leaderboards

From Guild Wars 2 Wiki
< API:2‎ | pvp‎ | seasons
Jump to: navigation, search

/v2/pvp/seasons/leaderboards

HTTP method
GET
Format
json
API version
version 2
Release date
2016-12-23
Scope
none
Optional
none

This resource returns information about League season leaderboards for either NA or EU.

Parameters

  • lang - (optional) Request localized information.

Response

If the root endpoint (/v2/pvp/seasons/:id/leaderboards) is accessed without specifying either NA or EU, the object list of [{"na", "eu"}] will be returned. A proper query should look similar to https://api.guildwars2.com/v2/pvp/seasons/A54849B7-7DBD-4958-91EF-72E18CD659BA/leaderboards/ladder/eu.

For the season ids of season 1-4, there will be an option to examine the legendary or guild endpoints. The guild endpoint will return the guild leaderboard, whereas the legendary will return the solo leaderboard.

For the season id of season 5, the endpoints legendary or guild are not available, replaced instead with ladder.

All endpoints will return an array of objects:

  • name (string) - Account name.
  • rank (number) - Rank for the given player/guild.
  • id (string) - Guild id.
  • team (string) (only for guild leaderboard) - Name of the team.
  • team_id (number) (only for guild leaderboard) - Internal team id.
  • date (string) - Date at which the rank is reached.
  • scores (array of objects) - array of objects containing the id and values for scorings
    • id (string) - Id for the scoring parameter. Can be compared to the values obtained from /v2/pvp/seasons/:id in the scorings array
    • value (number) - Value for the given id.


Example

Request

 1) https://api.guildwars2.com/v2/pvp/seasons/95D5B290-798A-421E-A919-1C2A75F74B72/leaderboards/legendary/na
 2) https://api.guildwars2.com/v2/pvp/seasons/A54849B7-7DBD-4958-91EF-72E18CD659BA/leaderboards/ladder/na

Response

1)

 [
   {
       "name": "AccountName.1234",
       "rank": 1,
       "date": "2016-04-18T01:41:11Z",
       "scores": [
           {
               "id": "E6487336-4B5B-4BFA-9CFA-9FF232CAEF85",
               "value": 30
           }
       ]
   },
   {...},
   {
       "name": "AccountName.1234",
       "rank": 48,
       "date": "2016-04-10T05:09:43Z",
       "scores": [
           {
               "id": "E6487336-4B5B-4BFA-9CFA-9FF232CAEF85",
               "value": 4
           }
       ]
   }
 ]

2)

 [
   {
   "name": "AccountName.1234",
   "rank": 1,
   "date": "2017-01-03T03:00:58Z",
   "scores": [
       {
           "id": "0F86D504-63C2-4465-80AA-C278E1CB7800",
           "value": 2136
       },
       {
           "id": "8A5F1199-CFD8-44CE-84C3-811C5EE8B16C",
           "value": 15
       },
       {
           "id": "FECEE3A5-B66C-44A3-B81E-65EA43829E1D",
           "value": 0
       }
     ]
   },
   {...},
   {
   "name": "AccountName.1234",
   "rank": 50,
   "date": "2017-01-03T18:26:29Z",
   "scores": [
       {
           "id": "0F86D504-63C2-4465-80AA-C278E1CB7800",
           "value": 1852
       },
       {
           "id": "8A5F1199-CFD8-44CE-84C3-811C5EE8B16C",
           "value": 21
       },
       {
           "id": "FECEE3A5-B66C-44A3-B81E-65EA43829E1D",
           "value": 9
       }
     ]
   }
 ]