Guildomatic API Documentation

Guildomatic offers an early release of an XML over HTTP based Application Programming Interface (API). The intent of the API is to make it easier for guild site owners, administrators and users to use their Guildomatic site and data to build other software tools, integrate with other systems, write scripts to download and analyze the data on an ongoing basis, and so forth. We welcome questions, comments and feedback on our support forums.

We will fill in this documentation with more detailed information as things evolve, but in meantime wanted to at least highlight the core methods available. Data formatting should be fairly apparent on review of sample XML responses for your own guild site.

For all example urls provided below, you should replace myguildname.guildomatic.com with the domain for your own guild site in order to access your guild data via the API.

Methods

Attendance

Example url: http://myguildname.guildomatic.com/api/attendance

Lists detail on raid attendance for all active guild members, along with each member's roster info so that a separate roster query isn't necessary to analyze or display results. Not paginated.

Supports passing a group parameter specifying the name of the "Attendance Group" to look up, else defaults to include all attendance groups. For instance, http://myguildname.guildomatic.com/api/attendance?group=Naxxramas.

Note that if the guild has their DKP data set to private, calling this method requires HTTP authentication with valid user credentials for a user who has permission to view DKP data.

Return to Methods »

Calendar

Example url: http://myguildname.guildomatic.com/api/calendar

Lists detail on all raid calendar events for the specified guild site, sorted by start date/time. Supports pagination via the page query parameter, for instance, http://myguildname.guildomatic.com/api/calendar?page=2.

Return to Methods »

DKP

Example url: http://myguildname.guildomatic.com/api/dkp

Lists detail on DKP for all active guild members, along with each member's roster info so that a separate roster query isn't necessary to analyze or display results. Not paginated.

Supports passing a group parameter specifying the name of the "DKP Group" to look up, else defaults to the guild's configured default DKP group. For instance, http://myguildname.guildomatic.com/api/dkp?group=T3.

Note that if the guild has their DKP data set to private, calling this method requires HTTP authentication with valid user credentials for a user who has permission to view DKP data.

Return to Methods »

Roster

Example url: http://myguildname.guildomatic.com/api/roster

Lists detail on guild members, by default only including active members. Not paginated. Supports an all parameter which, if true, returns both active and inactive members in the results. For instance, http://myguildname.guildomatic.com/api/roster?all=true.

Return to Methods »

Raid Items

Example url: http://myguildname.guildomatic.com/api/raid_items

Lists detail on all raid items or "loot" posted on the guild site. Supports pagination via the page query parameter, for instance, http://myguildname.guildomatic.com/api/raid_items?page=2.

Note that if the guild has their DKP data set to private, calling this method requires HTTP authentication with valid user credentials for a user who has permission to view DKP data.

Return to Methods »

Raids

Example url: http://myguildname.guildomatic.com/api/raids

Lists detail on all raids and any associated raid items or "loot" posted on the guild site. Supports pagination via the page query parameter, for instance, http://myguildname.guildomatic.com/api/raids?page=2.

Note that if the guild has their DKP data set to private, calling this method requires HTTP authentication with valid user credentials for a user who has permission to view DKP data.

Return to Methods »

© 2015 Guildomatic