API:Main

From Guild Wars 2 Wiki
(Redirected from API)
Jump to: navigation, search

The Guild Wars 2 API (application programming interface) is an interface that enables third-party applications to access data directly from the Guild Wars 2 servers. The current version of the API is version 2. For recent changes of the API, see the API changelog.

To discuss the Guild Wars 2 API, or in case of problems or required help, visit the official API development forums, the official API development GitHub, or the official Gitter.

Guild Wars 2 API Terms of Use

Any use of the APIs must comply with ArenaNet's Content Terms of Use and Website Terms of Use. Use of the APIs constitutes acceptance of the terms and conditions contained in the ArenaNet Content Terms of Use, Website Terms of Use, and any related terms or conditions when they are posted.

Help topics

  • Maps: How to use the map resources and the tile service to create maps.

Version 2 endpoints

The API version 2 provides the following endpoints:

Achievements

Authenticated

These endpoints access account data and require an API key to view.

  • account: Returns information about an account associated with an API key.
  • account/achievements: Returns information about an account's achievement progress.
  • account/bank: Returns information about a bank associated with an API key.
  • account/dyes: Returns information about unlocked dyes associated with an API key.
  • account/inventory: Returns information about the shared inventory slots associated with an API key.
  • account/materials: Returns information about a material storage associated with an API key.
  • account/minis: Returns information about unlocked miniatures associated with an API key.
  • account/skins: Returns information about unlocked skins associated with an API key.
  • account/wallet: Returns information about wealth associated with an API key.
  • characters: Returns information on an account's characters.
  • commerce/transactions: Returns information on an account's past and current trading post transactions.
  • pvp/stats: Returns general information on a player's performance in sPvP.
  • pvp/games: Returns more detailed information on the player's most recent sPvP matches.
  • pvp/standings: Returns the best and current standing of a player in sPvP leagues.
  • tokeninfo: Returns information about the supplied API Key.

Game Mechanics

Guild

  • emblem: Returns image resources needed to render guild emblems.
  • guild/permissions: Returns information about guild rank permissions.
  • guild/upgrades: Returns information about guild upgrades and scribe decorations.

Guild Authenticated

These endpoints access guild-specific data and require an API key from the guild owner to view.

Items

Map information

  • continents: Returns a list of continents and information about each continent
  • maps: Returns information about maps in the game

Structured PvP

Trading post

World vs. World

Miscellaneous

Version 1 endpoints

The API version 1 provides the following endpoints:

Dynamic events

  • events: Returns the current status of events for a specific world.
    • Note: This endpoint is obsolete due to the implementation of Megaserver technology. There are plans to replace it with something that returns data about the rotating world bosses, but nothing specific has been announced.
  • event_names: Returns a list of localized event names.
  • map_names: Returns a list of localized map names.
  • world_names: Returns a list of localized world names.
  • event_details: Returns detailed information about events.

Guilds

Items

Map information

  • continents: Returns a list of continents and information about each continent.
  • maps: Returns a list of maps in the game.
  • map_floor: Returns detailed information about a map floor

World vs. World

Miscellaneous

  • build: Returns the current build id.
  • colors: Returns a list of dyes in the game.
  • files: Returns commonly requested assets.

Services

  • Tile service: Provides world map tiles to create Guild Wars 2 maps
  • Render service: Provides access to in-game assets.
  • Additional resources are available as assets.

Other resources

List of wrappers

  • A list of wrapper libraries that provide high-level access to the API is available here.

List of applications

  • A list of applications that use the API is available here.

See also