API:2/pvp/seasons

From Guild Wars 2 Wiki
< API:2‎ | pvp
Jump to navigationJump to search

/v2/pvp/seasons

HTTP method
GET
Format
json
API version
version 2
Release date
2015-09-03
Scope
none
Optional
none

This resource returns information about League seasons.

Parameters

  • lang - (optional) Request localized information.

Response

If the root endpoint (/v2/pvp/seasons) is accessed without specifying an id, a list of all ids is returned. When multiple ids are requested using the ids parameter, a list of response objects is returned.

For each requested season id, an object with the following properties is returned:

  • id (string) - The season's UUID.
  • name (number) - The season's name.
  • start (string) - ISO timestamp for season start.
  • end (string) - ISO timestamp for season end.
  • active (boolean) - Whether or not the season is currently active.
  • divisions (array of objects) - a list of divisions.
    • name (string) - The division's name.
    • flags (array of strings) - Flags applying to the division.
      • CanLosePoints (only used in the first 4 seasons)
      • CanLoseTiers (only used in the first 4 seasons)
      • Repeatable
    • large_icon (string) - Path to the large icon.
    • small_icon (string) - Path to the small icon.
    • pip_icon (string) - Path to the pip icon.
    • tiers (array of objects) - a list of tiers.
      • points (number) - The number of pips required to complete the tier
  • ranks (array of objects, optional) - Contains details about the season's ranks (also known as badges, added in season five)
    • name (string) - The rank's name.
    • description (string) - The rank's description.
    • icon (string) - The full icon URL.
    • overlay (string) - The full URL for the rank's overlay icon.
    • overlay_small (string) - The full URL for a small variant of the rank's overlay icon.
    • tiers (array of objects) - The tiers of the rank.
      • rating (number) - The minimum PvP rating required for the tier.
  • leaderboards (array of objects) - Contains details on the current leaderboards
    • ladder
      • settings
        • name (string) - Seems to always be an empty string
        • duration (number) - Seems to always be null
        • scoring (string) - Indicates the primary scoring component.[verification requested]
        • tiers (array of objects)
      • scorings (array of objects) - Array used as reference to select player/guild scoring method
        • id (string) - The id for this scoring method, used as a reference in other endpoints.
        • type (string) - Will which variable type the content is saved as.
        • description (string) - Description of the scoring method (if any).
        • name (string) - Should represent the scoring method, such as "wins", "losses", and "skill rating".
        • ordering (string) - Will describe how the scoring is ordered.

Example

Request

 https://api.guildwars2.com/v2/pvp/seasons?id=44B85826-B5ED-4890-8C77-82DDF9F2CF2B
 https://api.guildwars2.com/v2/pvp/seasons/44B85826-B5ED-4890-8C77-82DDF9F2CF2B

Response

 {
   "id": "A54849B7-7DBD-4958-91EF-72E18CD659BA",
   "name": "PvP League Season Five",
   "start": "2016-12-13T20:00:00.000Z",
   "end": "2017-02-07T00:00:00.000Z",
   "active": true,
   "divisions": [
       {
           "name": "Cerulean",
           "flags": [ ],
           "pip_icon": "https://render.guildwars2.com/file/DF4AE7C6B85711B5EF0A970851672FFE230FE61D/1614836.png",
           "tiers": [
               {
                   "points": 20
               },
               {
                   "points": 20
               },
               {
                   "points": 20
               }
           ]
       },
       ...
       {
           "name": "Byzantium (Repeatable)",
           "flags": [
               "Repeatable"
           ],
           "pip_icon": "https://render.guildwars2.com/file/32A2E3C56EE514912A0AF41C9904AFAF64082D0B/1614841.png",
           "tiers": [
               {
                   "points": 30
               },
               ...
               {
                   "points": 30
               }
           ]
       }
   ],
   "leaderboards": {
       "ladder": {
           "settings": {
               "name": "",
               "duration": null,
               "scoring": "0F86D504-63C2-4465-80AA-C278E1CB7800",
               "tiers": [
                   {
                       "range": [
                           1,
                           1
                       ]
                   },
                   ...
                   {
                       "range": [
                           250,
                           101
                       ]
                   }
               ]
           },
           "scorings": [
               {
                   "id": "0F86D504-63C2-4465-80AA-C278E1CB7800",
                   "type": "Integer",
                   "description": "Effective rating that includes decay.",
                   "name": "Rating",
                   "ordering": "MoreIsBetter"
               },
               {
                   "id": "8A5F1199-CFD8-44CE-84C3-811C5EE8B16C",
                   "type": "Integer",
                   "description": "",
                   "name": "Wins",
                   "ordering": "MoreIsBetter"
               },
               {
                   "id": "FECEE3A5-B66C-44A3-B81E-65EA43829E1D",
                   "type": "Integer",
                   "description": "",
                   "name": "Losses",
                   "ordering": "LessIsBetter"
               }
           ]
       }
   }
 }

Notes

Divisions were structurally changed in PvP League Season Five. As of season five, pips are a purely reward-based system, and the CanLosePoints or CanLoseTiers flags are no longer used, as it's no longer possible to lose pips. A new skill rating system was introduced based on more traditional divisions: Bronze, Silver, Gold, Platinum, and Legendary. Unlike the previous pips-based system, the new skill rating system has no restrictions on backwards progress from losing matches or being inactive. The skill rating requirements for each division can be found in the ranks field of the response.