aiowowapi.retail.profile module
- class aiowowapi.retail.profile.Profile(api)
Bases:
objectThis class contains all API endpoints for the Profile category of the Retail World of Warcraft API
- Parameters
api (API) – An instance of our generic API object
- async get_character_achievement_statistics(realm_slug: str, character_name: str)
Returns a character’s statistics as they pertain to achievements.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a character’s statistics as they pertain to achievements.
- Return type
dict
- async get_character_achievements_summary(realm_slug: str, character_name: str)
Returns a summary of the achievements a character has completed.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of the achievements a character has completed.
- Return type
dict
- async get_character_appearance_summary(realm_slug: str, character_name: str)
Returns a summary of a character’s appearance settings.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of a character’s appearance settings.
- Return type
dict
- async get_character_collections_index(realm_slug: str, character_name: str)
Returns an index of collection types for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns an index of collection types for a character.
- Return type
dict
- async get_character_completed_quests(realm_slug: str, character_name: str)
Returns a list of quests that a character has completed.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a list of quests that a character has completed.
- Return type
dict
- async get_character_dungeons(realm_slug: str, character_name: str)
Returns a summary of a character’s completed dungeons.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of a character’s completed dungeons.
- Return type
dict
- async get_character_encounters_summary(realm_slug: str, character_name: str)
Returns a summary of a character’s encounters.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of a character’s encounters.
- Return type
dict
- async get_character_equipment_summary(realm_slug: str, character_name: str)
Returns a summary of the items equipped by a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of the items equipped by a character.
- Return type
dict
- async get_character_hunter_pets_summary(realm_slug: str, character_name: str)
If the character is a hunter, returns a summary of the character’s hunter pets. Otherwise, returns an HTTP 404 Not Found error.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
If the character is a hunter, returns a summary of the character’s hunter pets. Otherwise, returns an HTTP 404 Not Found error.
- Return type
dict
- async get_character_media_summary(realm_slug: str, character_name: str)
Returns a summary of the media assets available for a character (such as an avatar render).
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of the media assets available for a character (such as an avatar render).
- Return type
dict
- async get_character_mounts_collection_summary(realm_slug: str, character_name: str)
Returns a summary of the mounts a character has obtained.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of the mounts a character has obtained.
- Return type
dict
- async get_character_mythic_keystone_profile_index(realm_slug: str, character_name: str)
Returns the Mythic Keystone profile index for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns the Mythic Keystone profile index for a character.
- Return type
dict
- async get_character_mythic_keystone_season_details(realm_slug: str, character_name: str, season_id: str)
Returns the Mythic Keystone season details for a character.
Returns a 404 Not Found for characters that have not yet completed a Mythic Keystone dungeon for the specified season.
- param realm_slug
The slug of the realm.
- type realm_slug
str
- param character_name
The lowercase name of the character.
- type character_name
str
- param season_id
The ID of the Mythic Keystone season.
- type season_id
str
- return
Returns the Mythic Keystone season details for a character.
- rtype
dict
- async get_character_pets_collection_summary(realm_slug: str, character_name: str)
Returns a summary of the battle pets a character has obtained.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of the battle pets a character has obtained.
- Return type
dict
- async get_character_professions_summary(realm_slug: str, character_name: str)
Returns a summary of professions for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of professions for a character.
- Return type
dict
- async get_character_profile_status(realm_slug: str, character_name: str)
Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur: an HTTP 404 Not Found error is returned the is_valid value is false the returned character ID doesn’t match the previously recorded value for the character The following example illustrates how to use this endpoint: A client requests and stores information about a character, including its unique character ID and the timestamp of the request. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application. If the character is valid and the character IDs match, the client retains the data for another 30 days.
- param realm_slug
The slug of the realm.
- type realm_slug
str
- param character_name
The lowercase name of the character.
- type character_name
str
- return
Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
- rtype
dict
- async get_character_profile_summary(realm_slug: str, character_name: str)
Returns a profile summary for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a profile summary for a character.
- Return type
dict
- async get_character_pvp_bracket_statistics(realm_slug: str, character_name: str, pvp_bracket: str)
Returns the PvP bracket statistics for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
pvp_bracket (str) – The PvP bracket type.
- Returns
Returns the PvP bracket statistics for a character.
- Return type
dict
- async get_character_pvp_summary(realm_slug: str, character_name: str)
Returns a PvP summary for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a PvP summary for a character.
- Return type
dict
- async get_character_quests(realm_slug: str, character_name: str)
Returns a character’s active quests as well as a link to the character’s completed quests.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a character’s active quests as well as a link to the character’s completed quests.
- Return type
dict
- async get_character_raids(realm_slug: str, character_name: str)
Returns a summary of a character’s completed raids.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of a character’s completed raids.
- Return type
dict
- async get_character_reputations_summary(realm_slug: str, character_name: str)
Returns a summary of a character’s reputations.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of a character’s reputations.
- Return type
dict
- async get_character_soulbinds(realm_slug: str, character_name: str)
Returns a character’s soulbinds.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a character’s soulbinds.
- Return type
dict
- async get_character_specializations_summary(realm_slug: str, character_name: str)
Returns a summary of a character’s specializations.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of a character’s specializations.
- Return type
dict
- async get_character_statistics_summary(realm_slug: str, character_name: str)
Returns a statistics summary for a character.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a statistics summary for a character.
- Return type
dict
- async get_character_titles_summary(realm_slug: str, character_name: str)
Returns a summary of titles a character has obtained.
- Parameters
realm_slug (str) – The slug of the realm.
character_name (str) – The lowercase name of the character.
- Returns
Returns a summary of titles a character has obtained.
- Return type
dict
- async get_guild(realm_slug: str, name_slug: str)
Returns a single guild by its name and realm.
- Parameters
realm_slug (str) – The slug of the realm.
name_slug (str) – The slug of the guild.
- Returns
Returns a single guild by its name and realm.
- Return type
dict
- async get_guild_achievements(realm_slug: str, name_slug: str)
Returns a single guild’s achievements by name and realm.
- Parameters
realm_slug (str) – The slug of the realm.
name_slug (str) – The slug of the guild.
- Returns
Returns a single guild’s achievements by name and realm.
- Return type
dict
- async get_guild_activity(realm_slug: str, name_slug: str)
Returns a single guild’s activity by name and realm.
- Parameters
realm_slug (str) – The slug of the realm.
name_slug (str) – The slug of the guild.
- Returns
Returns a single guild’s activity by name and realm.
- Return type
dict
- async get_guild_roster(realm_slug: str, name_slug: str)
Returns a single guild’s roster by its name and realm.
- Parameters
realm_slug (str) – The slug of the realm.
name_slug (str) – The slug of the guild.
- Returns
Returns a single guild’s roster by its name and realm.
- Return type
dict
- async get_profile_api_resource(namespace: str, endpoint: str, params: Optional[dict] = None) Optional[dict]
Generic method for retrieving data from a Profile API endpoint
- Parameters
namespace (str) – The namespace of the resource we’re trying to access
endpoint (str) – The endpoint of the resource we’re trying to access
params (dict, optional) – Parameters to send with the request, defaults to None
- Returns
The result of the API request (Warning: Can be None/Null)
- Return type
dict