API:2/wvw/matches

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

/v2/wvw/matches

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

This resource returns further details about the specified match, including the total score, kills and deaths, and further details for each map.

Parameters

A match can be requested using any of the following parameters below. If more than one parameter is used, the endpoint will only use one.

The endpoint will look for a parameter to use in the following order, regardless of how they appear in the request URL: world, id, ids.

  • world (number) – The ID of one of the worlds participating in the match.
  • id (string) – A singular match ID. Can also be specified in the format /v2/wvw/matches/{id}.
  • ids (string) – A comma-separated list of multiple match IDs. Can also be used to specify a single match.

Sub end-points

For more detailed information in this endpoint it is possible to add /overview, /scores, or /stats in the form /v2/wvw/matches/stats.

The /overview sub-endpoint lists the world ids for each matches along with the start and end times. The /scores will return a detailed object of scores per map along with the overall score. /stats will return information on map specific, and overall, kills and deaths.

Response

If the root endpoint (/v2/wvw/matches) 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.

Additionally, a match can be found using the world parameter, specifying the world ID of a server. This will return the same data regarding the match that the specified server is participating in.

For each match requested, the following object is returned as a response:

  • id (string) – The WvW match id.
  • start_time (string) – The starting time of the matchup. (ISO-8601 Standard)
  • end_time (string) – The ending time of the matchup. (ISO-8601 Standard)
  • scores (object) – An object containing the score of the three servers, under the values red, blue, and green.
  • worlds (object) – An object containing the IDs of the three primary matchup worlds.
  • all_worlds (object) -An object containing an array of objects with the world IDs of the three servers, under the values red, blue, and green.
  • worlds (object) – An object containing the world IDs of the three combined servers, under the values red, blue, and green.
  • deaths (object) – An object containing the total deaths of the three servers, under the values red, blue, and green.
  • kills (object) – An object containing the total kills of the three servers, under the values red, blue, and green.
  • victory_points (object) - An object containing the victory points of the three servers, under the values red, blue, and green.
  • maps (array) – A list of objects containing detailed information about each of the four maps. The map detail objects contain the following properties:
    • id (number) - The map id
    • type (string) – The identifier for the map. Can be either RedHome, GreenHome or BlueHome for the borderlands or Center for Eternal Battlegrounds.
    • scores (list) – An object containing the score of the three servers for only the specified map, under the values red, blue, and green.
    • kills (object) – An object containing the total kills of the three servers for only the specified map, under the values red, blue, and green.
    • deaths (object) – An object containing the total deaths of the three servers for only the specified map, under the values red, blue, and green.
    • objectives (list) – A list of objective objects for this map. Each object contains the following properties:
      • id (string) – The objective id.
      • type (string) - The objective type, with possible values Spawn, Camp, Ruins, Tower, Keep, Castle, and Mercenary (Dredge/Krait/Frogs).
      • owner (string) – The current owner of the objective. Can be any one of Red, Green, Blue or Neutral.
      • last_flipped (string) – The time at which this objective was last captured by a server. (ISO-8601 Standard)
      • claimed_by (string) – The guild id of the guild currently claiming the objective, or null if not claimed.
      • claimed_at (string) – The time the objective was claimed by the claimed_by guild (ISO-8601 Standard), or null if not claimed.
      • points_tick (number) - The amount of points per tick the given objective yields.
      • points_capture (number) - The amount of points awarded for capturing the objective.
      • guild_upgrades (array of numbers) - An array of ids, resolvable against v2/guild/upgrades, showing which guild upgrades are currently slotted.
      • yaks_delivered (number) - The total amount of yak shipments delivered to the objective. Not limited to the shipments within the current tier only.
    • bonuses (list) – A list of all bonuses being granted by this map. If no player team owns a bonus from the map, this list is empty.
      • type (string) – A shorthand name for the bonus. Currently can only be Bloodlust.
      • owner (string) - The color representing which world group owns the bloodlust.
  • skirmishes (array of objects)
    • id (number) - The skirmish id
    • scores (object) - Object containing total scores for each team color, under the values red, blue, and green.
    • map_scores (array of objects) - Contains the map specific scores for the specific skirmish.
      • type (string) - Which map is being looked at, can have the values "Center", "RedHome", "BlueHome", or "GreenHome"
      • scores (object) - Object containing total scores for each team color on the selected map, under the values red, blue, and green.
  • victory_points (object) - Object containing the current victory points for each color, under the values red, blue, and green.

Example

Overview

https://api.guildwars2.com/v2/wvw/matches/1-3
 {
   "id": "1-2",
   "start_time": "2017-01-07T02:00:00Z",
   "end_time": "2017-01-14T02:00:00Z",
   "scores": {"red": 259699,"blue": 267584,"green": 378499},
   "worlds": {"red": 1016,"blue": 1018,"green": 1008},
   "all_worlds": {
       "red": [1007,1016],
       "blue": [1020,1022,1018],
       "green": [1008]
   },
   "deaths": {"red": 25666,"blue": 28013,"green": 17767},
   "kills": {"red": 15459,"blue": 19500,"green": 34070},
   "maps": [
     {
           "id": 1099,
           "type": "RedHome",
           "scores": {
               "red": 120623,
               "blue": 28139,
               "green": 13966
           },
           "bonuses": [{"type": "Bloodlust","owner": "Green"}],
           "objectives": [
               {
                   "id": "1099-99",
                   "type": "Camp",
                   "owner": "Red",
                   "last_flipped": "2017-01-11T12:17:34Z",
                   "claimed_by": "B27D2E5B-A57E-436C-9EE4-55B14195CC86",
                   "claimed_at": "2017-01-11T13:24:34Z",
                   "points_tick"    : 2,
                   "points_capture" : 2,
                   "guild_upgrades" : [123, 134],
                   "yaks_delivered" : 24
               },
               {
                   "id": "95-36",
                   "type": "Tower",
                   "owner": "Red",
                   "last_flipped": "2017-01-11T15:15:00Z",
                   "claimed_by": null,
                   "claimed_at": null,
                   "points_tick"    : 2,
                   "points_capture" : 2
                   },
               {...}
           ],
           "deaths": {"red": 3090,"blue": 2951,"green": 1307},
           "kills": {"red": 3255,"blue": 1794,"green": 1398}
       },
       {...}
       {
           "id": 38,
           "type": "Center",
           "scores": {"red": 92547,"blue": 83459,"green": 189060}
           ...
       }
   ]
 }

Sub end-points

 https://api.guildwars2.com/v2/wvw/matches/overview?world=1008
 {
   "id": "1-2",
   "worlds": {"red": 1016,"blue": 1018,"green": 1008},
   "all_worlds": {
       "red": [1007,1016],
       "blue": [1020,1022,1018],
       "green": [1008]
   },
   "start_time": "2017-01-07T02:00:00Z",
   "end_time": "2017-01-14T02:00:00Z"
 }
 https://api.guildwars2.com/v2/wvw/matches/scores?world=1008
 {
   "id": "1-2",
   "scores": {"red": 259490,"blue": 267484,"green": 378245},
   "maps": [
       {
           "id": 1099,
           "type": "RedHome",
           "scores": {"red": 120486,"blue": 28139,"green": 13962}
       },
       {
           "id": 95,
           "type": "GreenHome",
           ...
       },
       ...
   ]
 }
 https://api.guildwars2.com/v2/wvw/matches/stats?world=1008
 {
   "id": "1-2",
   "deaths": {"red": 25666,"blue": 28013,"green": 17767},
   "kills": {"red": 15459,"blue": 19500,"green": 34070},
   "maps": [
       {
           "id": 1099,
           "type": "RedHome",
           "deaths": "red": 3090,"blue": 2951,"green": 1307},
           "kills": {"red": 3255,"blue": 1794,"green": 1398}
       },
       {
           "id": 95,
           "type": "GreenHome",
           ...
       },
       ...
   ]
}