v4

latestOpenAPI 3.0.02026-07-3137328230.2 KB
guild

Retrieve information about a guild.

get/api/v1/guilds/profile

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.

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

Name of region to look up guild in. Can be one of: us, eu, kr, tw

Name of region to look up guild in. Can be one of: us, eu, kr, tw

realmstring required

Name of realm that guild is on. This can be in slug or title format, e.g. "Altar of Storms" or "altar-of-storms"

Name of realm that guild is on. This can be in slug or title format, e.g. "Altar of Storms" or "altar-of-storms"

namestring required

Name of the guild to look up. This is not case sensitive.

Name of the guild to look up. This is not case sensitive.

fieldsstring

Comma separated list of fields to retrieve for this guild.

Supported values:

  • <b>raid_progression</b>: retrieve raid progression data for guild. This can optionally take parameters to control what raids you are getting data for. These parameters can be numeric expansion IDs, specific raid slugs, or the terms "current-expansion", "previous-expansion", "current-tier", or "previous-tier".
  • <b>raid_rankings</b>: retrieve raid rankings data for guild. This can optionally take parameters to control what raids you are getting data for. These parameters can be numeric expansion IDs, specific raid slugs, or the terms "current-expansion", "previous-expansion", "current-tier", or "previous-tier".
  • <b>raid_encounters:RAID_SLUG:DIFFICULTY</b>: retrieve details on which encounters were defeated from a specific raid and difficulty
  • <b>members</b>: retrieve guild members details

Comma separated list of fields to retrieve for this guild.

Supported values:

  • <b>raid_progression</b>: retrieve raid progression data for guild. This can optionally take parameters to control what raids you are getting data for. These parameters can be numeric expansion IDs, specific raid slugs, or the terms "current-expansion", "previous-expansion", "current-tier", or "previous-tier".
  • <b>raid_rankings</b>: retrieve raid rankings data for guild. This can optionally take parameters to control what raids you are getting data for. These parameters can be numeric expansion IDs, specific raid slugs, or the terms "current-expansion", "previous-expansion", "current-tier", or "previous-tier".
  • <b>raid_encounters:RAID_SLUG:DIFFICULTY</b>: retrieve details on which encounters were defeated from a specific raid and difficulty
  • <b>members</b>: retrieve guild members details

Response

Successful

namestring required

Name of guild

faction'horde' | 'alliance' required
region'us' | 'eu' | 'tw' | 'kr' | 'cn' required
realmstring required

Realm guild resides on

profile_urlstring required

URL for Guild's profile on Raider.IO

Example response

{
  "name": "Ludicrous Speed",
  "faction": "horde",
  "region": "us",
  "realm": "Skullcrusher",
  "profile_url": "https://raider.io/guilds/us/skullcrusher/Ludicrous%20Speed",
  "raid_rankings": {
    "the-tidebound-grotto": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "the-venomous-abyss": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "sporefall": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "tier-mn-1": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "manaforge-omega": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "liberation-of-undermine": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "nerubar-palace": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "blackrock-depths": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "awakened-amirdrassil-the-dreams-hope": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "awakened-aberrus-the-shadowed-crucible": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "awakened-vault-of-the-incarnates": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "amirdrassil-the-dreams-hope": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "aberrus-the-shadowed-crucible": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "vault-of-the-incarnates": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "fated-sepulcher-of-the-first-ones": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "fated-sanctum-of-domination": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "fated-castle-nathria": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "sepulcher-of-the-first-ones": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "sanctum-of-domination": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "castle-nathria": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "nyalotha-the-waking-city": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "the-eternal-palace": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "crucible-of-storms": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "battle-of-dazaralor": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "uldir": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "antorus-the-burning-throne": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "tomb-of-sargeras": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "the-nighthold": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "trial-of-valor": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    },
    "the-emerald-nightmare": {
      "normal": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "heroic": {
        "world": 799,
        "region": 564,
        "realm": 20
      },
      "mythic": {
        "world": 799,
        "region": 564,
        "realm": 20
      }
    }
  },
  "raid_progression": {
    "the-tidebound-grotto": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "the-venomous-abyss": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "sporefall": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "tier-mn-1": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "manaforge-omega": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "liberation-of-undermine": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "nerubar-palace": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "blackrock-depths": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "awakened-amirdrassil-the-dreams-hope": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "awakened-aberrus-the-shadowed-crucible": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "awakened-vault-of-the-incarnates": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "amirdrassil-the-dreams-hope": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "aberrus-the-shadowed-crucible": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "vault-of-the-incarnates": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "fated-sepulcher-of-the-first-ones": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "fated-sanctum-of-domination": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "fated-castle-nathria": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "sepulcher-of-the-first-ones": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "sanctum-of-domination": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "castle-nathria": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "nyalotha-the-waking-city": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "the-eternal-palace": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "crucible-of-storms": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "battle-of-dazaralor": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "uldir": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "antorus-the-burning-throne": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "tomb-of-sargeras": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "the-nighthold": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "trial-of-valor": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    },
    "the-emerald-nightmare": {
      "summary": "4/10 H",
      "expansion_id": 11,
      "total_bosses": 10,
      "heroic_bosses_killed": 4
    }
  }
}