Retrieve a guild's best progress on a specific boss, including best health percentage, total pull count, and kill status. Ideal for progress widgets and stream overlays.
Changed onRelies on combat log data retrieved from the Raider.IO Desktop App.<br><br>This is the most commonly used endpoint for stream overlays and progress widgets. Returns a single summary object rather than per-pull detail.<br><br>Identify the guild using <b>either</b> <code>guild_id</code> <b>or</b> the <code>region</code>/<code>realm</code>/<code>guild</code> combination.
Request
- Base URLhttp://raider.io
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The API key from your RaiderIO App: http://raider.io/settings/apps. Apps with API keys have higher rate limits.
Raid slug or full name (e.g. "the-unbinding-of-kithix" or "The Unbinding of Kith'ix")
Boss name in slug form (e.g. "the-silken-court"). Use "latest" for the most recent boss being progressed.
Raid difficulty. One of: mythic, heroic, normal
Lockout period. One of: "current", "until_kill", "all", or an integer period ID.
Raider.IO guild ID. Alternative to the region/realm/guild parameters.
Region to filter by. One of: world, us, eu, kr, tw Required if guild_id not provided.
Realm name. Accepts slug form (e.g. "altar-of-storms") or display name (e.g. "Altar of Storms") Required if guild_id not provided.
Guild name. Not case sensitive. Required if guild_id not provided.
Response
Successful
Example response
{
"guild": {
"id": 955,
"name": "Ludicrous Speed",
"faction": "horde",
"realm": {
"id": 114,
"connectedRealmId": 114,
"wowRealmId": 57,
"wowConnectedRealmId": 11,
"name": "Skullcrusher",
"slug": "skullcrusher",
"altSlug": "skullcrusher",
"locale": "en_US",
"realmType": "pve"
},
"region": {
"name": "United States & Oceania",
"short_name": "US",
"slug": "us"
},
"path": "/guilds/us/skullcrusher/Ludicrous%20Speed",
"logo": "https://cdn.raider.io/images/site/horde_icon4.png",
"color": "#ff6600"
},
"raid": {
"id": 100,
"slug": "nerubar-palace",
"name": "Nerub-ar Palace",
"short_name": "NP"
},
"boss": {
"slug": "the-silken-court",
"name": "The Silken Court"
},
"overallProgress": {
"summary": "7/8 Mythic",
"difficulty": "mythic",
"totalBosses": 8,
"defeatedBosses": 7,
"normalBossesKilled": 8,
"heroicBossesKilled": 8,
"mythicBossesKilled": 7
},
"bestPercent": 32.1,
"bestAttemptDurationMs": 245000,
"boss_percent": 32.1,
"phase": 2.1,
"phase_label": "P2.1",
"progress_display": "P2 32.1%",
"pullCount": 147,
"pullStartedAt": "2026-01-15T20:30:00.000Z"
}Changes
- info
added the new enum value
the-unbinding-of-kithixto thequeryrequest parameterraid
- info
- info
added the new enum value
the-tidebound-grottoto thequeryrequest parameterraid
- info