character
Retrieve information about a character.
Changed onget/api/v1/characters/profile
Request
- Base URLhttp://raider.io
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
access_keystring
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 character in. Can be one of: us, eu, kr, tw
realmstring required
Name of realm that character is on. This can be in slug or title format, e.g. "Altar of Storms" or "altar-of-storms"
namestring required
Name of the character to look up. This is not case sensitive.
fieldsstring
Comma separated list of fields to retrieve for this character.
General fields:
- <b>gear</b>: retrieve high level item information for player
- <b>talents</b>: retrieve talent and loadout information for player
- <b>talents:categorized</b>: retrieve talent and loadout information for player, separated into class and spec talents
- <b>guild</b>: retrieve basic information about guild the player is in
- <b>covenant</b>: retrieve the covenant and renown level of the player
Raiding fields:
- <b>raid_progression</b>: retrieve raid progression data for character. Defaults to Current Expansion. Can add one or more parameters to request specific raids. e.g.: raid_progression:9 would return all of Dragonflight, or raid_progression:nerubar-palace would return just Nerubar Palace. You can also specify :current-expansion, :previous-expansion, :current-tier, or :previous-tier. See the raiding/static-data endpoint for slugs, and expansion ids.
Mythic Plus fields:
- <b>mythic_plus_scores_by_season</b>: retrieve scores by mythic plus season. You can specify one or more season by appending multiple ':<season-slug>' values to this field. You can also use the alias 'current' and 'previous' instead of a season name to request that relative season. For example: mythic_plus_scores_by_season:current will request the current season using mythic_plus_scores_by_season:season-tww-1:season-df-4 will return both seasons. Not specifying a season will default to the current season. Note: Results are returned in an array that matches the order of the seasons in the request.
- <b>mythic_plus_ranks</b>: retrieve current season mythic plus rankings for player.
- <b>mythic_plus_recent_runs</b>: retrieve ten most recent mythic plus runs for player (current season only).
- <b>mythic_plus_best_runs</b>: retrieve ten most high scoring mythic plus runs for player (current season only). Specify the paramater :all to retrieve all of a character's best runs for the season.
- <b>mythic_plus_alternate_runs</b>: retrieve ten most high scoring mythic plus alternate runs for player (current season only). Specify the paramater :all to retrieve all of a character's alternate runs for the season. This is available starting Shadowlands Season 1 Post.
- <b>mythic_plus_highest_level_runs</b>: retrieve the player's ten highest Mythic+ runs by Mythic+ level (current season only)
- <b>mythic_plus_weekly_highest_level_runs</b>: retrieve the player's ten highest Mythic+ runs by Mythic+ level for the current raid week (current season only)
- <b>mythic_plus_previous_weekly_highest_level_runs</b>: retrieve the player's ten highest Mythic+ runs by Mythic+ level for the previous raid week (current season only)
- <b>mythic_plus_dungeon_run_counts</b>: retrieve the number of runs (total and timed) the player has completed for each dungeon in the season's dungeon pool, zero-filled for dungeons without runs. Defaults to the current season; append ':<season-slug>' to request a specific season, e.g. mythic_plus_dungeon_run_counts:season-tww-1.
- <b>previous_mythic_plus_ranks</b>: retrieve mythic plus rankings for player.
Other fields:
- <b>raid_achievement_meta</b>: retrieve raid achievement meta status for a player. This request requires that you specify parameters for the specific tiers you're looking for. For example if you add ':tier21' to the field you will get the status of Tier 21's meta. Multiple tiers can be added to a single request: ':tier21:tier20:tier19'.
- <b>raid_achievement_curve</b>: retrieve AOTC/Cutting Edge achievement status for a given raid slug (or multiple). Multiple slugs can be specified by separating them by colons.
Response
Successful
Example response
{
"name": "Ulsoga",
"race": "Orc",
"class": "Warlock",
"active_spec_name": "Affliction",
"active_spec_role": "DPS",
"gender": "female",
"faction": "horde",
"achievement_points": 23905,
"thumbnail_url": "https://render.worldofwarcraft.com/us/character/burning-blade/0/239444992-avatar.jpg?alt=/wow/static/images/2d/avatar/1-0.jpg",
"region": "us",
"realm": "Skullcrusher",
"last_crawled_at": "2024-10-09T04:31:20.000Z",
"profile_url": "https://raider.io/characters/us/skullcrusher/Ulsoga",
"profile_banner": "classbanner_paladin1",
"raid_progression": {
"the-unbinding-of-kithix": {
"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
},
"the-tidebound-grotto": {
"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
}
},
"mythic_plus_ranks": {
"overall": {
"world": 799,
"region": 564,
"realm": 20
},
"tank": {
"world": 799,
"region": 564,
"realm": 20
},
"healer": {
"world": 799,
"region": 564,
"realm": 20
},
"dps": {
"world": 799,
"region": 564,
"realm": 20
},
"class": {
"world": 799,
"region": 564,
"realm": 20
},
"class_tank": {
"world": 799,
"region": 564,
"realm": 20
},
"class_healer": {
"world": 799,
"region": 564,
"realm": 20
},
"class_dps": {
"world": 799,
"region": 564,
"realm": 20
}
},
"previous_mythic_plus_ranks": {
"overall": {
"world": 799,
"region": 564,
"realm": 20
},
"tank": {
"world": 799,
"region": 564,
"realm": 20
},
"healer": {
"world": 799,
"region": 564,
"realm": 20
},
"dps": {
"world": 799,
"region": 564,
"realm": 20
},
"class": {
"world": 799,
"region": 564,
"realm": 20
},
"class_tank": {
"world": 799,
"region": 564,
"realm": 20
},
"class_healer": {
"world": 799,
"region": 564,
"realm": 20
},
"class_dps": {
"world": 799,
"region": 564,
"realm": 20
}
},
"mythic_plus_recent_runs": [
{
"dungeon": "Mists of Tirna Scithe",
"short_name": "MISTS",
"mythic_level": 10,
"keystone_run_id": 16196237,
"completed_at": "2024-09-22T03:02:51.000Z",
"clear_time_ms": 1636548,
"par_time_ms": 1800999,
"num_keystone_upgrades": 2,
"map_challenge_mode_id": 375,
"zone_id": 13334,
"zone_expansion_id": 8,
"icon_url": "https://cdn.raiderio.net/images/wow/icons/large/achievement_dungeon_mistsoftirnascithe.jpg",
"background_image_url": "https://cdn.raiderio.net/images/dungeons/expansion8/base/mists-of-tirna-scithe.jpg",
"score": 326.6,
"url": "https://raider.io/mythic-plus-runs/season-tww-1/5376417-10-mists-of-tirna-scithe",
"affixes": [
{
"id": 148,
"name": "Xal'atath's Bargain: Ascendant",
"description": "While in combat, Xal'atath rains down orbs of cosmic energy that empower enemies or players.",
"icon": "inv_nullstone_cosmicvoid",
"icon_url": "https://cdn.raiderio.net/images/wow/icons/large/inv_nullstone_cosmicvoid.jpg",
"wowhead_url": "https://wowhead.com/affix=148"
}
],
"role": "tank"
}
],
"mythic_plus_best_runs": [
{
"dungeon": "Mists of Tirna Scithe",
"short_name": "MISTS",
"mythic_level": 10,
"keystone_run_id": 16196237,
"completed_at": "2024-09-22T03:02:51.000Z",
"clear_time_ms": 1636548,
"par_time_ms": 1800999,
"num_keystone_upgrades": 2,
"map_challenge_mode_id": 375,
"zone_id": 13334,
"zone_expansion_id": 8,
"icon_url": "https://cdn.raiderio.net/images/wow/icons/large/achievement_dungeon_mistsoftirnascithe.jpg",
"background_image_url": "https://cdn.raiderio.net/images/dungeons/expansion8/base/mists-of-tirna-scithe.jpg",
"score": 326.6,
"url": "https://raider.io/mythic-plus-runs/season-tww-1/5376417-10-mists-of-tirna-scithe",
"affixes": [
{
"id": 148,
"name": "Xal'atath's Bargain: Ascendant",
"description": "While in combat, Xal'atath rains down orbs of cosmic energy that empower enemies or players.",
"icon": "inv_nullstone_cosmicvoid",
"icon_url": "https://cdn.raiderio.net/images/wow/icons/large/inv_nullstone_cosmicvoid.jpg",
"wowhead_url": "https://wowhead.com/affix=148"
}
],
"role": "tank"
}
],
"mythic_plus_alternate_runs": [
{
"dungeon": "Mists of Tirna Scithe",
"short_name": "MISTS",
"mythic_level": 10,
"keystone_run_id": 16196237,
"completed_at": "2024-09-22T03:02:51.000Z",
"clear_time_ms": 1636548,
"par_time_ms": 1800999,
"num_keystone_upgrades": 2,
"map_challenge_mode_id": 375,
"zone_id": 13334,
"zone_expansion_id": 8,
"icon_url": "https://cdn.raiderio.net/images/wow/icons/large/achievement_dungeon_mistsoftirnascithe.jpg",
"background_image_url": "https://cdn.raiderio.net/images/dungeons/expansion8/base/mists-of-tirna-scithe.jpg",
"score": 326.6,
"url": "https://raider.io/mythic-plus-runs/season-tww-1/5376417-10-mists-of-tirna-scithe",
"affixes": [
{
"id": 148,
"name": "Xal'atath's Bargain: Ascendant",
"description": "While in combat, Xal'atath rains down orbs of cosmic energy that empower enemies or players.",
"icon": "inv_nullstone_cosmicvoid",
"icon_url": "https://cdn.raiderio.net/images/wow/icons/large/inv_nullstone_cosmicvoid.jpg",
"wowhead_url": "https://wowhead.com/affix=148"
}
],
"role": "tank"
}
],
"mythic_plus_dungeon_run_counts": [
{
"zone_id": 13334,
"dungeon": "Mists of Tirna Scithe",
"short_name": "MISTS",
"season_runs_total": 17,
"season_runs_timed": 12
}
]
}Changes
- info
added the optional property
/to the response with the status
- info
- info
added the optional property
to the response with the status
- info