[API Suggestion] Guilds

#1 - May 23, 2013, 11:50 p.m.
Blizzard Post

Ok, what i expect from a guild API:

  • Guild name & Tag (public)
  • Guild info & search tags (which may be specified by the leader ingame) (public)
  • Ranking (public, doesn’t apply yet, eh?)
  • Memberlist (authorized)
  • Chat (authorized)
  • Ability to queue upgrades, invite/kick members & stuff (authorized & if allowed ofc)
#28 - May 28, 2013, 1:41 p.m.
Blizzard Post

OK, so for the first guild API release, this is what I’m considering:

/v1/guild_details.json?guild_id=xxxx

Would return name, tag, and emblem data.

The emblem would be in the form
“%i, %i, %i, %i, %i, %i”
background ID, foreground ID, flags, color 0, color 1, color 2
flags define things like flip image horizontally or vertically

like “1,62,0,114,114,93”

At some point we’d like to be able to render images on our servers so that you don’t have to, but that’s not available yet. I know there are some emblem creator websites and apps already — is this enough information to feed into those so that you can generate emblems?

Also, if you have any other ideas for public information that would be useful that could go into this API, let me know. Your ideas for authenticated/private APIs are good — this thread will be a useful reference for when we have the ability to implement them.

#31 - May 28, 2013, 3:58 p.m.
Blizzard Post

Is there any way to list what World(s) the Guild plays on?

I think so. I’ll look into it. Like you said, it might get kind of bloated with stale information.

Are you planning on having a “guild list” api, like you did for items and recipes, such that all guilds are discoverable, or are you only allowing them to be linked to?

Not at the moment. For now you’ll need to get guild IDs as a result of something like the WvW status API.

#45 - June 3, 2013, 11:41 p.m.
Blizzard Post

The foreground and background IDs for this match the order on the wiki (http://wiki.guildwars2.com/wiki/Gallery_of_guild_emblems). Do you know if the IDs returned by the API will match these or will there be another order for them?

The numbers I assigned to them for the wiki are simply sequential based on their file ID order within Gw2.dat. I seem to remember that this matched the order that they appear within the in-game emblem designer, so it may very well match up to the in-game IDs (although I wouldn’t count on it).

Turns out that YES, the emblems are displayed at the Emblemer in the order of their internal ID, and since my numbering matched the display order, the numbers on the wiki match the internal IDs.

Unfortunately, when I numbered the backgrounds, I forgot to account for the “blank” background, so the numbers on the wiki are (ID – 1) instead of matching the ID exactly. Still, it’s a systematic difference.

I’ve zipped up the game textures (converted to PNG) with the correct IDs, and you can grab them over here (File->Download or Ctrl+S to download). Use in conjunction with colors.json to build guild emblem wizards!

Edit: had a sync error on my GDrive, link is fixed now

Nice! I’m glad that worked.

#84 - Sept. 25, 2013, 5:31 p.m.
Blizzard Post

Hi coderjoe,

Yes, we do have plans to offer guild and character APIs in an authenticated fashion (via OAuth2) – but secured to a particular user. For example, you would programmatically be able to obtain last-login/representation information for yourself, not any arbitrary user in your guild.

It sounds like what you would like is some enhanced permissions for guild leaders to obtain members’ guild stats. We will definitely keep this in mind when implementing the guild APIs. Thank you for the suggestion.

#95 - Jan. 9, 2014, 7:26 p.m.
Blizzard Post

Hi Lolage,

Yes, I expect ultimately we would allow guild leaders to obtain guild representation and other basic guild activity of their members.

Regarding the ‘Eve’ approach to API keys: we instead are going with the OAuth2 approach, in which it is up to the 3rd party app to request required information permissions and the user may allow or deny these permissions en masse.