Roster:API

Latest revision as of 03:49, 23 May 2012

Important note: When you edit this page, you agree to release your contribution into the public domain. If you do not want this or can not do this because of license restrictions, please do not edit.

Languages:

English  • Deutsch

Roster API

The Roster to WoW API uses the feeds from Blizzard for character and guild information and can be used in Roster and its AddOns.

Features include:

• Character info
  • Basic information: name, level, class, race, gender, faction, guild, achievement points
  • Optional fields: equipped items, stats, reputation, primary and secondary skills, achievements/statistics, talents, titles, collected mounts and companions, quests, profession recipes, Hunter pets, PvP information

• Guild
  • Basic information: name, level, achievement points
  • Optional fields: members (roster), achievements

• Arena Teams
  • Basic information: name, ranking, rating, weekly/season statistics
  • Optional fields: members (roster)

Character API

Used to query for data on any valid Character (level 10 and up)

Usage:

$roster->api->Char->getCharInfo($Server, $CharName, $Fields);

Returns a JSON formatted array contaning data from the fields requested

getCharInfo has 3 parameters ($Server, $CharName, $Fields)

• $Server - the name of the server the character is located on
• $CharName - the name of the character
• $Fields - specific data you want to get for this character, use ":" for multiple fields

Field options are as follows:

• 1 (guild) - A summary of the guild that the character belongs to. If the character does not belong to a guild and this field is requested, this field will not be exposed.
• 2 (stats) - A map of character attributes and stats.
• 3 (talents) - A list of talent structures.
• 4 (items) - A list of items equipted by the character. Use of this field will also include the average item level and average item level equipped for the character.
• 5 (reputation) - A list of the factions that the character has an associated reputation with.
• 6 (titles) - A list of the titles obtained by the character.
• 7 (professions) - A list of the character's professions. It is important to note that when this information is retrieved, it will also include the known recipes of each of the listed professions.
• 8 (appearance) - A map of values that describes the face, features and helm/cloak display preferences and attributes.
• 9 (companions) - A list of all of the non-combat pets obtained by the character.
• 10 (mounts) - A list of all of the mounts obtained by the character.
• 11 (pets) - A list of all of the combat pets obtained by the character.
• 12 (achievements) - A map of achievement data including completion timestamps and criteria information.
• 13 (progression) - A list of raids and bosses indicating raid progression and completedness.
• 14 (pvp) - A list of battleground vistories and teams.
• 15 (quests) - A list of completed quests by the character.
• 16 (feed) - A list of recent achievements items obtained, progression, statistics.

Guild API

Used to query for data on any valid Guild

Usage:

$roster->api->Guild->getGuildInfo($rname, $name, $fields);

Returns a JSON formatted array contaning data from the fields requested

getGuildInfo has 3 variables ($rname, $name, $fields)

• $ranme - the name of the server the guild is located on
• $name - the name of the Guild
• $Fields - specific data you want to get for this character, use ":" for multiple fields

Field options are as follows

• 1 (members) - A summary of the guilds members.
• 2 (achievements) - an array of guild achievements completed (only id's given).
• 3 (news) - A list of recent guild news.

Guild rewards

$roster->api->Guild->getGuildrewards($rname, $name, $fields)

This returns a list of the rewards the specified guild has earned.

Data API

$roster->api->Data->getRacesInfo()

• Returns a list of raceId's with faction alignment

$roster->api->Data->getQuestInfo($id)

• Returns info for the requested quest id ($id)

 "id":13157,
 "title":"The Crusaders' Pinnacle",
 "reqLevel":77,
 "suggestedPartyMembers":0,
 "category":"Icecrown",
 "level":79

$roster->api->Data->getClassesInfo()

• Returns id name and power type for all classes

$roster->api->Data->getItemInfo($itemID, $gem0=null, $gem1=null, $gem2=null, $enchant=null, $es=false)

• Returns JSON data for the formation of tooltips of the given item id

Note:

$gem0, $gem1, $gem2, $enchant, $es are not used as of yet

$roster->api->Data->getAchievInfo()

• Returns the list of all achievements and categories

Realm API

Team API

Talent API