World of Warcraft API This is the main reference page for the WoW UI Lua API available to user Macros and AddOns . This is the API available during normal game play . See also WoW Glue API . Introduction . The World of Warcraft API , or WoW API , is a set of Lua functions and facilities provided by the Blizzard WoW Client , to allow interaction with the " World of Warcraft " and its user interface . The list below is incomplete , and kept up to date through user contributions . See also the an automatically - generated exhaustive list of all API functions present in the latest live client . For beginners , WoW AddOn contains a number of very informative sources to help get you started . You can also to find examples of how the various functions are used by the default UI . Discuss any large - scale changes on the . Reference . Global API functions for WoW in Lua . If you ' re contributing documentation , please read . Function names can be prefixed with the following tags , see : Calling functions via macro or command line : Account . These functions only return meaningful values on Asian realms ; all three relate to the play time limitation system . Achievement . These functions are only available in Patch 3 . 0 Action . These functions are those which operate with the action buttons . See # Activity section for general player actions . Activity . These functions make the player do something , and which aren ' t covered elsewhere and aren ' t simply confirmation steps . Archaeology . Functions for the Archaeology Profession . Added in 4 . 0 . 1 Cataclysm . Barber Shop . These functions were introduced in 3 . 0 . 2 . Camera . ' Mouse Look ' refers to holding down the right mouse button and controlling the movement direction . Shifting the view by holding down the ' left ' mouse button is not covered by these APIs . Channel . These are chat functions which are specific to channels . Also see the # Chat Window and # Communication sections . Chat Window . These are functions which are specific to chat ' window ' management . See also the # Channel and # Communication sections . See Mikk ' s spiel on chat windows , which may be out of date . These functions get applied after reload ui ( index 1 is General and index 2 is Combat Log ) : Communication . These are functions communicate with other players . Also see the # Channel and # Chat Window sections . Companion . These functions relate to companions , mounts and non - combat pets . All functions were introduced in 3 . 0 . Container / Bag . These functions manage containers , bags , backpacks . See also # Inventory and # Bank sections . Currency . Most of these functions were added in 3 . 0 . 2 . Dressing Room . Functions controlling the ' dressing room ' interface . ( added 1700 ) Dungeon Finder . Functions supporting the Dungeon Finder UI , added in 3 . 3 . See also the # Raid Browser and # Looking for Group sections . Equipment . Equipment management was added in 3 . 1 . 2 . Group . See also the # Raid section . Guild Bank . All functions were added in 2 . 3 . Inventory . These functions manage your inventory , that is ' equipped items ' . See also the # Container / Bag and # Bank sections . Item . These functions operate on item links or item information directly . See also the # Container / Bag and # Inventory sections . Item Socketing . The following were introduced along with socketed items and gems in 2 . 0 . The ' id ' refers to a 1 - based index of the sockets in the item being considered for socketing . Item Text . These functions relate to item text : books , etc . . . Location . These functions relate to the current location of the player and how it ' s displayed . Looking for Group . Functions for use in the ' Looking for Group ' tool . See also the # Dungeon Finder and # Raid Browser sections . Loot . Automatic looting behavior is controlled by autoLootDefalt CVar . Mail . See also Events associated with Mail . Mapping . These functions are related to display of the world map . Movement . Most of these functions may only called on a hardware event from ' secure ' code . Music Player . These functions were exclusive to the Mac client , added in 1 . 12 . The functions are protected and are only called through key bindings , thus they only serve to enable you to bind specific keys to control iTunes while using the WoW client . Petition . Petitions are signup documents for guilds and arena teams . Some functions below only apply to a particular petition type . Quest . See also the # Gossip section . Raid . See also the # Group section . Raid Browser . Functions hidden supporting the Raid Browser UI , added in 3 . 3 . See also the # Dungeon Finder and # Looking for Group sections . " This is a very preliminary list of functions by perusing FrameXML \ LFRFrame . lua / xml files . Please edit and contribute if you know more about these = ) " These also " appear " to be used by the Raid Browser , as well as the Dungeon Finder : RealID ( BNet ) . These functions are only available in Patch 3 . 3 . 5 . Recruit - a - Friend . Note : Only usable by people that have been referred or have referred someone . Script Profiling . Note : CPU profiling is disabled by default since it has some overhead . CPU profiling is controlled by the scriptProfile CVar , which persists across sessions , and takes effect after a UI reload . Memory profiling is always available . These functions were added in Patch 2 . 1 . Spell . The ' spellID ' is the index of a spell in a spellbook . The indices increase from top to bottom , then left to right , then between categories , e . g . : General - > Discipline . spellIDs will change as players learn new spells and ' professions ' . Talent . Talent points preview , assignment before spending , was added in 3 . 1 . 0 : Unit . These are functions which act on one or more units . Units are identified by UnitId s . Vehicle . These functions were added in Patch 3 . 0 . 2 . Voice Chat . These functions were added in Patch 2 . 2 . World Battlefield . The following functions are used for population - limited world PvP zones , primarily Lake Wintergrasp . External links . Discussion : News :