Sign in

v5

latestOpenAPI 3.0.02026-08-0437328230.2 KB
Live Tracking - Raiding

Return a pre-formatted string for use in Twitch/Discord bot commands. Supports template variables ($PCT, $BOSS, $PULL, $DIFFICULTY) for custom formatting.

Relies on combat log data retrieved from the Raider.IO Desktop App.<br><br>Returns a plain-text string (not JSON). Use the <code>template</code> parameter to customize the output format with variables: <code>$PCT</code> (best percent), <code>$BOSS</code> (boss name), <code>$PULL</code> (pull count), <code>$DIFFICULTY</code> (difficulty name).<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/raiding/bot-commands/{cmd}

Path parameters

cmd'best-percent' | 'pull-count' | 'percent-and-pulls' | 'itemlevel' required

Bot command to execute. One of: best-percent, pull-count, percent-and-pulls, itemlevel

Bot command to execute. One of: best-percent, pull-count, percent-and-pulls, itemlevel

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.

templatestring

Template to use for formatting results. You can put in special replacement values: $PCT, $BOSS, $PULL, $DIFFICULTY

Template to use for formatting results. You can put in special replacement values: $PCT, $BOSS, $PULL, $DIFFICULTY

Response

Formatted bot command response string

string required

Formatted bot command response string