---
title: "Active-raid discovery and exact five-row guild leaderboard window for the character Overview dashboard"
method: GET
path: "/api/v1/client/guild-rivals"
tags: ["raiding"]
---

# Active-raid discovery and exact five-row guild leaderboard window for the character Overview dashboard

`GET /api/v1/client/guild-rivals`

## Query parameters

- `access_key` string — The API key from your RaiderIO App: http://raider.io/settings/apps. Apps with API keys have higher rate limits.
- `guildId` integer, required — Current guild ID
- `scope` 'realm' | 'subregion' | 'region' | 'world' — Shared geographic scope for every active raid block
- `raid` string — Selected active raid slug
- `difficulty` 'normal' | 'heroic' | 'mythic' — Selected difficulty for the requested raid

## Response `200`

Successful

- GuildRivalsResponse
  - `scope` 'realm' | 'subregion' | 'region' | 'world', required
  - `guildId` integer, required
  - `activeRaids` Model2[], required
    - `raid` Raid, required
    - `difficulties` Model1[], required
      - `difficulty` 'normal' | 'heroic' | 'mythic', required
      - `selfRank` integer, required
  - `selected` Selected, nullable, required
    - `raid` Raid, required
    - `difficulty` 'normal' | 'heroic' | 'mythic', required
    - `scope` 'realm' | 'subregion' | 'region' | 'world', required
    - `entries` Model3[], required
      - `rank` integer, required
      - `guild` Guild, required
      - `isSelf` boolean, required
      - `progress` integer, required
      - `pull` Pull, nullable, required
        - `encounter` Encounter, required
        - `percent` number, nullable, required
        - `count` integer, nullable, required
    - `fullRankingPath` string, required

---

[API](https://skmtc.net/raider/apis/raider-io-developer-api.md) · [All operations](https://skmtc.net/raider/apis/raider-io-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raider/raider-io-developer-api/revisions/d89777d7faee/schema)
