Figure 1
First-run API Key Entry Window
Figure 2
GW2 Command Options Window

API Key

Before you can use GW2 Command, you must first have a valid Guild Wars 2 account and you must acquire an API Key.

You can acquire your API Key, or manage existing keys, by visiting the ArenaNet Applications page.

An API Key allows third-party applications, tools, and websites to access read-only limited or specific information about your Guild Wars 2 account; such as your character names, your inventory bank, etc. When you share an API Key, you are granting permission and access to the account information authorized for that key. You can have multiple API Keys.

An API Key never provides sensitive information such as your login or password and it never allows altering of your account information.

An API Key will usually look like a series of numbers and characters seperated into blocks by dashes; similar to the following:

1XX1XX-XX1X-X1XX-XX1X-11112XX1XX1X2X1-XX1X-1XXX-XXX1-XXXX1X

The first time you run GW2 Command after you install it, you will be asked to enter your API Key (Figure 1). You may then opt to have GW2 Command save your API Key for the next time you run the application. It is highly reccomended that you allow GW2 Command to save your API Key. Your API Key is saved in a safe and secure method locally on your computer and it is never shared by GW2 Command, except with the Guild Wars 2 API servers and the GW2 Command servers, without first acquiring your explicit permission.

Optionally, or after you have run GW2 Command for the first time, you may remove your existing API Key or enter a new one through the Options window (Figure 2). You can also change the option to have GW2 Command save your API Key and you can view details about the API Key that is currently loaded and being used by GW2 Command.

For the best experience using GW2 Command, you will want to provide an API Key that has the most permissions and access to your Guild Wars 2 account information.

API Key Settings

API Keys ceated on the ArenaNet Applications page can have the following settings:

  • accountAll API Keys have this setting by default and this setting cannot be removed or revoked for a key. This setting tells third-party applications, tools, and websites that this API Key is valid and grants access to your basic Guild Wars 2 account information such as your account's id, creation date, game expansions owned, etc.
  • builds(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access character PvE, PvP, and WvW equipment, skill, and utility builds from your Guild Wars 2 account. If this API Key does not also have the characters setting, this setting will generally not allow access to information.
  • characters(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access the list of characters and basic information about the characters from your Guild Wars 2 account.
  • guilds(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access detailed information for guilds which you are the owner of. This setting does not allow access to information for guild which you are a member - but not owner - of.
  • inventories(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access inventories from your Guild Wars 2 account. Inventories include your account bank, shared account inventory slots, character inventories (if the characters setting is also provided), etc.
  • progression(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access progressions from your Guild Wars 2 account. Progressions includes achievements, collections, etc.
  • pvp(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access detailed pvp information from your Guild Wars 2 account.
  • unlocks(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access unlocks from your Guild Wars 2 account. Unlocks include skins, minis, finishers, etc.
  • wallet(Optional) Allows third-party applications, tools, and websites that are provided with this API Key to access the wallet from your Guild Wars 2 account. The wallet is usually where currencies you earn in-game are stored; currencies such as Gold, Gems, Karma, Dungeon Tokens, etc.

06-08-2016 8:30 AM DB
GW2 Command & GW2Command.com Copyright © 2013-2016 David M. Bandler & Emily C. Bandler / Bandler Media Productions, All Rights Reserved. All content, images, works of art, photographs, designs, information, and all other data contained within this site are the sole property of David M. Bandler & Emily C. Bandler. No use, reuse, copying, duplication, distribution, exhibition, modification, sale, syndication, or possession or use in any manner without express written permission. Bandler Media Productions, GW2 Command, the GW2 Command logo, and all associated logos and designs are trademakrs or registered trademarks of David M. Bandler & Emily C. Bandler.

Guild Wars 2 © 2010–2013 ArenaNet, LLC. and NC Interactive, LLC. All rights reserved. Guild Wars, Guild Wars 2, ArenaNet, NCSOFT, the Interlocking NC Logo, and all associated logos and designs are trademarks or registered trademarks of NCSOFT Corporation.

All other trademarks are the property of their respective owners.