RAraider
raiding

Retrieve the raid rankings for a given raid and region

Changed on
get/api/v1/raiding/raid-rankings

Request

Query parameters

access_keystring

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

raid'the-unbinding-of-kithix' | 'the-venomous-abyss' | 'the-tidebound-grotto' | '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' required

Raid to look up. This can be the raid's full name ("The Unbinding of Kith'ix") or its name in slug form: "the-unbinding-of-kithix"

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

One of: mythic, heroic, normal

regionstring required

Name of region to restrict progress to. Can be a primary region: world, us, eu, kr, tw. Or a subregion: english, french, german, italian, oceanic, russian, spanish, eu-english, eu-portuguese, eu-spanish, us-english, brazil, us-spanish, us-central, us-eastern, us-mountain, us-pacific

realmstring

Name of realm to restrict to. Prefix with connected- to retrieve rankings from the connected realm. Requires that region be a standard region: us, eu, kr, tw.

guildsstring

Guild IDs of guilds to restrict the results to. Allows filtering to up to 10 different guilds.

limitinteger
pageinteger

Response

Successful

Example response

{
  "raidRankings": [
    {
      "guild": {
        "region": {
          "name": "United States & Oceania",
          "short_name": "US",
          "slug": "us"
        }
      },
      "encountersPulled": [
        {
          "bestPercent": 48.98,
          "bossPercent": 29.93,
          "phase": 2,
          "phaseLabel": "P2",
          "progressDisplay": "29.93% P2"
        }
      ]
    }
  ]
}

Changes

  • 088fa4d90886Revision changes
    • info

      added the new enum value the-unbinding-of-kithix to the query request parameter raid

  • 189e26801b0aRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status