API:1/map_floor

From Guild Wars 2 Wiki
Jump to: navigation, search

/v1/map_floor.json

HTTP method
GET
Format
json
API version
version 1
Release date
 ?
Scope
none
Optional
none

This resource returns details about a map floor, used to populate a world map. All coordinates are map coordinates.

The returned data only contains static content. Dynamic content, such as vendors, is not currently available.

Parameters

Required parameters
  • continent_id – The continent.
  • floor – The map floor.
Optional parameters
  • lang – Show localized texts in the specified language.

Response

The response is an object with the following properties:

  • texture_dims (dimension) – The dimensions of the texture.
  • clamped_view (rectangle) - If present, it represents a rectangle of downloadable textures. Every tile coordinate outside this rectangle is not available on the tile server.
  • regions (object) – A mapping from region id to an object.

Each region object contains the following properties:

  • name (string) – The region name.
  • label_coord (coordinate) – The coordinates of the region label.
  • maps (object) – A mapping from the map id to an object.

Each map object contains the following properties:

  • name (string) – The map name.
  • min_level (number) – The minimum level of the map.
  • max_level (number) – The maximum level of the map.
  • default_floor (number) – The default floor of the map.
  • map_rect (rectangle) – The dimensions of the map, given as the coordinates of the lower-left (SW) and upper-right (NE) corners.
  • continent_rect (rectangle) – The dimensions of the map within the continent coordinate system, given as the coordinates of the upper-left (NW) and lower-right (SE) corners.
  • points_of_interest (list) – A list of points of interest (landmarks, waypoints and vistas)
  • tasks (list) – A list of renown hearts.
  • skill_challenges (list) – A list of skill challenges.
  • sectors (list) – A list of areas within the map.

Each element of the points_of_interest list is an object with the following properties:

  • poi_id (number) – The point of interest id.
  • name (string) – The name of the point of interest.
  • type (string) – The type. This can be either "landmark" for actual points of interest, "waypoint" for waypoints, or "vista" for vistas.
  • floor (number) – The floor of this object.
  • coord (coordinate) – The coordinates of this object.

Each element of the tasks list is an object with the following properties:

  • task_id (number) – The renown heart id.
  • objective (string) – The objective or name of the heart.
  • level (number) – The level of the heart.
  • coord (coordinate) – The coordinates where it takes place.

Each element of the skill_challenges list is an object with the following properties:

  • coord (coordinate) – The coordinates of this skill challenge.

Each element of the sector list is an object with the following properties:

  • sector_id (number) – The area id.
  • name (string) – The name of the area.
  • level (number) – The level of the area.
  • coord (coordinate) – The coordinates of this area (this is usually the center position).
Special types
  • Dimension properties are two-element lists of width and height.
  • Coordinate properties are two-element lists of the x and y position.
  • Rectangle properties are two-element lists of coordinates.

Example

https://api.guildwars2.com/v1/map_floor.json?continent_id=1&floor=1

{
  "texture_dims": [ 32768, 32768 ],
  "regions": {
    "1": {
      "name": "Shiverpeak Mountains",
      "label_coord": [ 19840, 13568 ],
      "maps": {
        "31": {
          "name": "Snowden Drifts",
          "min_level": 15,
          "max_level": 25,
          "default_floor": 1,
          "map_rect": [
            [ -49152, -24576 ],
            [ 49152, 24576 ]
          ],
          "continent_rect": [
            [ 17664, 11264 ],
            [ 21760, 13312 ]
          ],
          "points_of_interest": [
            {
              "poi_id": 164,
              "name": "Blasted Haven",
              "type": "landmark",
              "floor": 1,
              "coord": [ 20768.5, 11893.5 ]
            },
            ...
          ],
          "tasks": [
            {
              "task_id": 28,
              "objective": "Help hunters and travelers near the road.",
              "level": 15,
              "coord": [ 21326.4, 11982.8 ]
            },
            ...
          ],
          "skill_challenges": [
            {
              "coord": [ 18922.3, 11445.5 ]
            },
            ...
          ],
          "sectors": [
            {
              "sector_id": 1015,
              "name": "King Jalis's Refuge",
              "level": 19,
              "coord": [ 21673.8, 12111.8 ]
            },
            ...
          ]
        },
        ...
      }
    },
    "4": {
      "name": "Kryta",
      "label_coord": [ 13440, 13696 ],
      "maps": {
        "15": {
          "name": "Queensdale",
          ...
        },
        ...
      }
    },
    ...
  }
}