Wow API Encounters

Encounters API (Retail — Patch 12.0.0)

Comprehensive reference for encounter journal, mythic+, instances, scenarios, raid locks, and seasons.

Source: https://warcraft.wiki.gg/wiki/World_of_Warcraft_API Current as of: Patch 12.0.0 (Build 65655) — January 28, 2026 Scope: Retail only.

Scope

• Encounter Journal — Boss database, loot tables, abilities
• C_ChallengeMode — M+ keystones, affixes, timers
• C_MythicPlus — Weekly M+ runs, rating, seasonal
• ScenarioInfo — Scenarios, delves, stages
• InstanceLeaverInfo — Deserter/leaver info
• Raid Locks — Saved instance lockouts
• C_SeasonInfo — Seasonal content

Encounter Journal

Instance Navigation

Encounter (Boss) Data

Section (Ability) Data

Section Info Fields

• title — Section title
• description — Section text
• headerType — Header type enum
• abilityIcon — Icon texture
• creatureDisplayID — Display ID
• siblingSectionID — Next sibling
• firstChildSectionID — First child
• filteredByDifficulty — Hidden by difficulty filter?
• link — Journal link
• startsOpen — Default expanded?

Loot

Difficulty

Search

C_ChallengeMode — Mythic+ Keystones

Keystone Info

Map & Affix Data

Completion & Records

Rewards

C_MythicPlus — Seasonal M+ Data

ScenarioInfo — Scenarios & Delves

Scenario Info Fields

• name — Scenario name
• currentStage — Current stage
• numStages — Total stages
• flags — Scenario flags
• isComplete — Completed?
• xp — XP reward
• money — Gold reward
• type — Scenario type
• area — Area name
• uiTextureKit — UI texture kit

Step Info Fields

• title — Step title
• description — Step description
• numCriteria — Criteria count
• isComplete — Step complete?
• isBonusObjective — Bonus objective?
• isFinal — Final step?
• weightedProgress — Progress percentage

Raid Locks (Saved Instances)

InstanceLeaverInfo — Deserter

C_SeasonInfo — Seasonal Content

Common Patterns

List Encounter Journal Bosses

-- Select an instance and list its bosses
EJ_SelectTier(EJ_GetCurrentTier())
EJ_SelectInstance(instanceID)

local index = 1
while true do
    local name, description, encounterID, rootSectionID = EJ_GetEncounterInfoByIndex(index)
    if not name then break end
    print(index, name, "- EncounterID:", encounterID)
    index = index + 1
end

Show M+ Keystone Info

local function ShowKeystoneInfo()
    local level = C_MythicPlus.GetOwnedKeystoneLevel()
    local mapID = C_MythicPlus.GetOwnedKeystoneChallengeMapID()
    if level and mapID then
        local name = C_ChallengeMode.GetMapUIInfo(mapID)
        print("Keystone:", name, "+", level)
    else
        print("No keystone")
    end
    
    local score = C_MythicPlus.GetOverallDungeonScore()
    print("M+ Rating:", score or 0)
end

Check Active M+ Progress

local function ShowMythicPlusProgress()
    if not C_ChallengeMode.IsChallengeModeActive() then
        print("Not in an active M+")
        return
    end
    
    local level = C_ChallengeMode.GetActiveChallengeModeLevel()
    local mapID = C_ChallengeMode.GetActiveChallengeMapID()
    local name = C_ChallengeMode.GetMapUIInfo(mapID)
    local deaths, timeLost = C_ChallengeMode.GetDeathCount()
    
    print(name, "+", level)
    print("Deaths:", deaths, "Time lost:", timeLost, "sec")
end

List Saved Instances

RequestRaidInfo()
-- Wait for UPDATE_INSTANCE_INFO event, then:
local numSaved = GetNumSavedInstances()
for i = 1, numSaved do
    local name, id, reset, difficulty, locked, extended, 
          _, isRaid, maxPlayers, diffName, numEncounters, progress = 
          GetSavedInstanceInfo(i)
    if locked then
        print(name, diffName, progress .. "/" .. numEncounters, 
              "Reset:", SecondsToTime(reset))
    end
end

Key Events

Gotchas & Restrictions

1. EJ data is async — Loot data loads asynchronously. Wait for EJ_LOOT_DATA_RECIEVED before reading loot.
2. Tier selection matters — EJ functions operate on the currently selected tier. Always set tier first.
3. M+ completion data is temporary — GetCompletionInfo() only returns data immediately after a run.
4. Keystone slotting requires hardware event — Players must manually interact with the Font of Power.
5. Raid lock extensions — SetSavedInstanceExtend() must be called during the lock's active period.
6. Scenario types vary — Delves, island expeditions, and scenarios all use ScenarioInfo with different type flags.
7. M+ rating is per-season — GetOverallDungeonScore() resets each season.
8. RequestRaidInfo() is async — Wait for UPDATE_INSTANCE_INFO before reading saved instances.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.