1---
2name: wow-api-guild
3description: "Complete reference for WoW Retail Guild Management, Guild Bank, Guild Info, and Guild Event APIs. Covers guild management functions (invite, promote, demote, kick, disband, MOTD, info), guild roster (GetGuildRosterInfo, GuildRoster, sorting), guild bank functions (GetGuildBankItemInfo, deposit, withdraw, tab management, permissions), guild perks/reputation, C_GuildInfo, and the Club API guild integration (guilds are ClubType.Guild in the Club system). Use when working with guild management, guild roster, guild bank, guild chat, guild events, or guild achievements."
4metadata:
5 source: https://skillmd.com/skills/jburlison/wow-api-guild
6---
7
8# Guild API (Retail — Patch 12.0.0)
9
10Comprehensive reference for guild management, guild bank, and guild info APIs.
11
12> **Source:** https://warcraft.wiki.gg/wiki/World_of_Warcraft_API
13> **Current as of:** Patch 12.0.0 (Build 65655) — January 28, 2026
14> **Scope:** Retail only.
15
16---
17
18## Scope
19
20- **Guild Management** — Invite, promote, demote, kick, disband, MOTD
21- **Guild Roster** — Member list, info, sorting
22- **Guild Bank** — Item management, tabs, permissions
23- **C_GuildInfo** — Guild info utilities
24- **Club Integration** — Guilds as C_Club entities
25
26---
27
28## Guild Management
29
30### Core Functions
31
32| Function | Returns | Description |
33|----------|---------|-------------|
34| `IsInGuild()` | `inGuild` | Is player in a guild? |
35| `GetGuildInfo(unit)` | `guildName, guildRankName, guildRankIndex, realm` | Guild info for unit |
36| `GetGuildFactionGroup()` | `factionGroup` | Guild faction (0=Horde, 1=Alliance) |
37| `GuildInvite(name)` | — | Invite player to guild |
38| `GuildUninvite(name)` | — | Remove from guild |
39| `GuildPromote(name)` | — | Promote one rank |
40| `GuildDemote(name)` | — | Demote one rank |
41| `GuildSetLeader(name)` | — | Transfer leadership |
42| `GuildDisband()` | — | Disband guild |
43| `GuildLeave()` | — | Leave guild |
44| `GuildSetMOTD(motd)` | — | Set message of the day |
45| `GetGuildRosterMOTD()` | `motd` | Get MOTD |
46| `GuildRosterSetPublicNote(index, note)` | — | Set public note |
47| `GuildRosterSetOfficerNote(index, note)` | — | Set officer note |
48| `GuildControlSetRank(rankIndex)` | — | Select rank for editing |
49| `GuildControlSetRankFlag(flagIndex, enabled)` | — | Set rank permission |
50| `GuildControlGetRankFlags()` | `flags` | Get rank permissions |
51| `GuildControlGetNumRanks()` | `numRanks` | Number of ranks |
52| `GuildControlGetRankName(rankIndex)` | `name` | Rank name |
53| `GuildControlAddRank(name)` | — | Add new rank |
54| `GuildControlDelRank(rankIndex)` | — | Delete rank |
55| `GuildControlSaveRank(name)` | — | Save rank changes |
56
57### Guild Roster
58
59| Function | Returns | Description |
60|----------|---------|-------------|
61| `GetNumGuildMembers()` | `totalMembers, numOnline, numOnlineAndMobile` | Member counts |
62| `GetGuildRosterInfo(index)` | `name, rankName, rankIndex, level, classDisplayName, zone, publicNote, officerNote, isOnline, status, class, achievementPoints, achievementRank, isMobile, isSoREligible, standingID` | Member info |
63| `GetGuildRosterLastOnline(index)` | `years, months, days, hours` | Last online time |
64| `GuildRoster()` | — | Request roster refresh |
65| `SortGuildRoster(sortType)` | — | Sort roster |
66| `SetGuildRosterShowOffline(showOffline)` | — | Toggle offline display |
67| `GetGuildRosterShowOffline()` | `showOffline` | Showing offline? |
68| `SetGuildRosterSelection(index)` | — | Select member |
69| `GetGuildRosterSelection()` | `index` | Selected member |
70
71---
72
73## C_GuildInfo
74
75| Function | Returns | Description |
76|----------|---------|-------------|
77| `C_GuildInfo.GetGuildNewsInfo(index)` | `newsInfo` | Guild news item |
78| `C_GuildInfo.GetGuildTabardInfo(unit)` | `tabardInfo` | Guild tabard details |
79| `C_GuildInfo.GuildRoster()` | — | Request roster update |
80| `C_GuildInfo.QueryGuildMemberRecipes(guildMemberGUID, skillLineID)` | — | Query member recipes |
81| `C_GuildInfo.QueryGuildMembersForRecipe(skillLineID, spellID [, recipeLevel])` | — | Query who knows recipe |
82| `C_GuildInfo.RemoveFromGuild(guid)` | — | Remove by GUID |
83| `C_GuildInfo.IsGuildOfficer()` | `isOfficer` | Is player officer? |
84| `C_GuildInfo.IsGuildRankAssignmentAllowed(guid, rankOrder)` | `isAllowed` | Can assign rank? |
85| `C_GuildInfo.SetGuildRankOrder(guid, rankOrder)` | — | Set member rank |
86| `C_GuildInfo.SetNote(guid, note, isPublic)` | — | Set public/officer note |
87| `C_GuildInfo.CanEditOfficerNote()` | `canEdit` | Can edit officer notes? |
88| `C_GuildInfo.CanSpeakInGuildChat()` | `canSpeak` | Can talk in guild chat? |
89| `C_GuildInfo.CanViewOfficerNote()` | `canView` | Can view officer notes? |
90| `C_GuildInfo.GetGuildRankOrder(guid)` | `rankOrder` | Member rank order |
91| `C_GuildInfo.MemberExistsByName(name)` | `exists` | Member in guild? |
92
93---
94
95## Guild Bank
96
97### Guild Bank Items
98
99| Function | Returns | Description |
100|----------|---------|-------------|
101| `GetGuildBankNumSlots(tab)` | `numSlots` | Slots in bank tab |
102| `GetGuildBankItemInfo(tab, slot)` | `texture, itemCount, locked, isFiltered, quality` | Item info |
103| `GetGuildBankItemLink(tab, slot)` | `link` | Item link |
104| `GetGuildBankItemValue(tab, slot)` | `value` | Item vendor value |
105| `AutoStoreGuildBankItem(tab, slot)` | — | Move to bags |
106| `SplitGuildBankItem(tab, slot, amount)` | — | Split stack |
107| `PickupGuildBankItem(tab, slot)` | — | Pick up item |
108| `QueryGuildBankTab(tab)` | — | Request tab data |
109| `QueryGuildBankLog(tab)` | — | Request tab log |
110| `QueryGuildBankText(tab)` | — | Request tab info text |
111
112### Guild Bank Tabs
113
114| Function | Returns | Description |
115|----------|---------|-------------|
116| `GetNumGuildBankTabs()` | `numTabs` | Number of bank tabs |
117| `GetGuildBankTabInfo(tab)` | `name, icon, isViewable, canDeposit, numWithdrawals, remainingWithdrawals` | Tab info |
118| `SetGuildBankTabInfo(tab, name, icon)` | — | Edit tab name/icon |
119| `BuyGuildBankTab()` | — | Purchase new tab |
120| `GetGuildBankTabCost()` | `cost` | Next tab cost |
121| `GetGuildBankText(tab)` | `text` | Tab info text |
122| `SetGuildBankText(tab, text)` | — | Set tab info text |
123| `CanGuildBankRepair()` | `canRepair` | Can repair from guild bank? |
124| `GetGuildBankWithdrawMoney()` | `amount` | Withdrawal allowance |
125| `GetGuildBankMoney()` | `money` | Guild bank gold |
126| `DepositGuildBankMoney(amount)` | — | Deposit gold |
127| `WithdrawGuildBankMoney(amount)` | — | Withdraw gold |
128| `CanWithdrawGuildBankMoney()` | `canWithdraw` | Can withdraw gold? |
129| `GetGuildBankMoneyTransaction(index)` | `type, name, amount, years, months, days, hours` | Money log entry |
130| `GetNumGuildBankMoneyTransactions()` | `numTransactions` | Money log count |
131
132### Guild Bank Log
133
134| Function | Returns | Description |
135|----------|---------|-------------|
136| `GetNumGuildBankTransactions(tab)` | `numTransactions` | Tab transaction count |
137| `GetGuildBankTransaction(tab, index)` | `type, name, itemLink, count, tab1, tab2, year, month, day, hour` | Transaction entry |
138
139---
140
141## Guild + Club Integration
142
143Guilds are represented as clubs with `Enum.ClubType.Guild` in the C_Club system:
144
145```lua
146-- Get guild as a club
147local clubs = C_Club.GetSubscribedClubs()
148for _, club in ipairs(clubs) do
149 if club.clubType == Enum.ClubType.Guild then
150 local guildClubId = club.clubId
151 -- Use C_Club functions for guild chat streams
152 local streams = C_Club.GetStreams(guildClubId)
153 break
154 end
155end
156```
157
158---
159
160## Common Patterns
161
162### Iterate Guild Roster
163
164```lua
165local function PrintGuildMembers()
166 local numMembers = GetNumGuildMembers()
167 for i = 1, numMembers do
168 local name, rankName, rankIndex, level, classDisplayName, zone,
169 publicNote, officerNote, isOnline = GetGuildRosterInfo(i)
170 if isOnline then
171 print(name, level, classDisplayName, zone)
172 end
173 end
174end
175
176-- Must request roster first
177C_GuildInfo.GuildRoster()
178```
179
180### Guild Bank Interaction
181
182```lua
183-- List items in guild bank tab 1
184local function ListGuildBankTab(tab)
185 local numSlots = GetGuildBankNumSlots(tab)
186 for slot = 1, numSlots do
187 local texture, itemCount, locked, isFiltered, quality = GetGuildBankItemInfo(tab, slot)
188 if texture then
189 local link = GetGuildBankItemLink(tab, slot)
190 print(link, "x" .. (itemCount or 1))
191 end
192 end
193end
194```
195
196---
197
198## Key Events
199
200| Event | Payload | Description |
201|-------|---------|-------------|
202| `GUILD_ROSTER_UPDATE` | canRequestRosterUpdate | Roster data refreshed |
203| `GUILD_RANKS_UPDATE` | — | Rank structure changed |
204| `GUILD_MOTD` | motdText | MOTD received |
205| `GUILD_NEWS_UPDATE` | — | Guild news updated |
206| `GUILD_INVITE_REQUEST` | inviter, guildName, guildAchievementPoints, oldGuildName, isNewGuild, ... | Guild invite received |
207| `GUILD_INVITE_CANCEL` | — | Invite cancelled |
208| `PLAYER_GUILD_UPDATE` | unitTarget | Guild status changed |
209| `GUILD_TRADESKILL_UPDATE` | — | Guild tradeskill updated |
210| `GUILD_RECIPE_KNOWN_BY_MEMBERS` | — | Recipe query result |
211| `GUILDBANK_ITEM_LOCK_CHANGED` | — | Bank item lock changed |
212| `GUILDBANK_UPDATE_TABS` | — | Bank tabs updated |
213| `GUILDBANK_UPDATE_MONEY` | — | Bank money changed |
214| `GUILDBANK_UPDATE_TEXT` | tab | Bank info text updated |
215| `GUILDBANKBAGSLOTS_CHANGED` | — | Bank slots changed |
216| `GUILDBANKFRAME_OPENED` | — | Bank frame opened |
217| `GUILDBANKFRAME_CLOSED` | — | Bank frame closed |
218| `GUILDBANKLOG_UPDATE` | — | Bank log updated |
219
220---
221
222## Gotchas & Restrictions
223
2241. **Roster request required** — Call `C_GuildInfo.GuildRoster()` before reading roster. Data isn't always current.
2252. **Guild bank requires NPC** — Guild bank functions only work when at a guild bank NPC.
2263. **Permissions vary by rank** — Check permissions before attempting operations. `CanGuildBankRepair()`, `CanWithdrawGuildBankMoney()`, etc.
2274. **QueryGuildBankTab is async** — Must query each tab and wait for `GUILDBANK_UPDATE_TABS` before reading items.
2285. **Guild = Club** — Guild chat uses `C_Club` with `Enum.ClubType.Guild`. Use `C_Club.SendMessage()` for guild chat.
2296. **Rank indices** — Rank 0 = Guild Master. Higher indices = lower ranks.
2307. **GetGuildRosterInfo index** — 1-based index into the roster. Not related to rank or any other ordering.
2318. **MOTD event timing** — `GUILD_MOTD` fires during login. Register early to catch it.