Sign in

v4

OpenAPI 3.0.02026-07-3137328230.2 KB
Live Tracking - Raiding

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.

Relies 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.

get/api/v1/live-tracking/guild/boss-progress

Query parameters

access_keystring

The API key from your RaiderIO App: http://raider.io/settings/apps. Apps with API keys have higher rate limits.

The API key from your RaiderIO App: http://raider.io/settings/apps. Apps with API keys have higher rate limits.

raid'the-tidebound-grotto' | 'the-venomous-abyss' | 'sporefall' | 'tier-mn-1' | 'manaforge-omega' | 'liberation-of-undermine' | 'nerubar-palace' | 'blackrock-depths' | 'awakened-amirdrassil-the-dreams-hope' | 'awakened-aberrus-the-shadowed-crucible' | 'awakened-vault-of-the-incarnates' | 'amirdrassil-the-dreams-hope' | 'aberrus-the-shadowed-crucible' | 'vault-of-the-incarnates' | 'fated-sepulcher-of-the-first-ones' | 'fated-sanctum-of-domination' | 'fated-castle-nathria' | 'sepulcher-of-the-first-ones' | 'sanctum-of-domination' | 'castle-nathria' | 'nyalotha-the-waking-city' | 'the-eternal-palace' | 'crucible-of-storms' | 'battle-of-dazaralor' | 'uldir' | 'antorus-the-burning-throne' | 'tomb-of-sargeras' | 'the-nighthold' | 'trial-of-valor' | 'the-emerald-nightmare' | 'latest' required

Raid slug or full name (e.g. "sporefall" or "Sporefall")

Raid slug or full name (e.g. "sporefall" or "Sporefall")

boss'latest' required

Boss name in slug form (e.g. "the-silken-court"). Use "latest" for the most recent boss being progressed.

Boss name in slug form (e.g. "the-silken-court"). Use "latest" for the most recent boss being progressed.

difficulty'mythic' | 'heroic' | 'normal' | 'latest' required

Raid difficulty. One of: mythic, heroic, normal

Raid difficulty. One of: mythic, heroic, normal

periodstring

Lockout period. One of: "current", "until_kill", "all", or an integer period ID.

Lockout period. One of: "current", "until_kill", "all", or an integer period ID.

guild_idinteger

Raider.IO guild ID. Alternative to the region/realm/guild parameters.

Raider.IO guild ID. Alternative to the region/realm/guild parameters.

region'us' | 'eu' | 'tw' | 'kr' | 'cn' | 'world'

Region to filter by. One of: world, us, eu, kr, tw Required if guild_id not provided.

Region to filter by. One of: world, us, eu, kr, tw Required if guild_id not provided.

realmstring

Realm name. Accepts slug form (e.g. "altar-of-storms") or display name (e.g. "Altar of Storms") 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.

guildstring

Guild name. Not case sensitive. Required if guild_id not provided.

Guild name. Not case sensitive. Required if guild_id not provided.

Response

Successful

bestPercentnumber nullable

Best overall health % reached on this boss (0-100). Null if no attempts.

bestAttemptDurationMsinteger nullable

Encounter duration in milliseconds for the attempt used to calculate phase progress

boss_percentnumber nullable

Best primary boss health % reached (0-100). Null if the boss has no health tracking.

phasenumber nullable

Furthest encounter phase number reached, or null if not phased

phase_labelstring nullable

Furthest encounter phase label reached, or null if not phased

progress_displaystring

Human-readable progress string (e.g. "45.2%", "P2 32.1%")

pullCountinteger nullable

Total number of recorded pulls on this boss

pullStartedAtstring nullable

ISO 8601 timestamp of the most recent pull

isDefeatedboolean

Whether the boss has been killed

widgetVersioninteger

Widget version for cache invalidation

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"
}