aiowowapi.retail.game_data module
- class aiowowapi.retail.game_data.GameData(api)
Bases:
object
This class contains all API endpoints for the GameData category of the Retail World of Warcraft API
- Parameters
api (API) – An instance of our generic API object
- async get_achievement(achievement_id: int)
Returns an achievement by ID.
- Parameters
achievement_id (int) – The ID of the achievement.
- Returns
Returns an achievement by ID.
- Return type
dict
- async get_achievement_categories_index()
Returns an index of achievement categories.
- Returns
Returns an index of achievement categories.
- Return type
dict
- async get_achievement_category(achievement_category_id: int)
Returns an achievement category by ID.
- Parameters
achievement_category_id (int) – The ID of the achievement category.
- Returns
Returns an achievement category by ID.
- Return type
dict
- async get_achievement_media(achievement_id: int)
Returns media for an achievement by ID.
- Parameters
achievement_id (int) – The ID of the achievement.
- Returns
Returns media for an achievement by ID.
- Return type
dict
- async get_achievements_index()
Returns an index of achievements.
- Returns
Returns an index of achievements.
- Return type
dict
- async get_auctions(connected_realm_id: int)
Returns all active auctions for a connected realm.
See the Connected Realm API for information about retrieving a list of connected realm IDs.
Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
- param connected_realm_id
The ID of the connected realm.
- type connected_realm_id
int
- return
Returns all active auctions for a connected realm.
- rtype
dict
- async get_azerite_essence(azerite_essence_id: str)
Returns an azerite essence by ID.
- Parameters
azerite_essence_id (str) – The ID of the azerite essence.
- Returns
Returns an azerite essence by ID.
- Return type
dict
- async get_azerite_essence_media(azerite_essence_id: int)
Returns media for an azerite essence by ID.
- Parameters
azerite_essence_id (int) – The ID of the azerite essence.
- Returns
Returns media for an azerite essence by ID.
- Return type
dict
- async get_azerite_essence_search(search_params: Optional[dict] = None)
Performs a search of azerite essences. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of azerite essences. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_azerite_essences_index()
Returns an index of azerite essences.
- Returns
Returns an index of azerite essences.
- Return type
dict
- async get_commodities()
Returns all active auctions for commodity items for the entire game region.
Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
- return
Returns all active auctions for commodity items for the entire game region.
- rtype
dict
- async get_conduit(conduit_id: int)
Returns a conduit by ID.
- Parameters
conduit_id (int) – The ID of the conduit.
- Returns
Returns a conduit by ID.
- Return type
dict
- async get_conduit_index()
Returns an index of conduits.
- Returns
Returns an index of conduits.
- Return type
dict
- async get_connected_realm(connected_realm_id: int)
Returns a connected realm by ID.
- Parameters
connected_realm_id (int) – The ID of the connected realm.
- Returns
Returns a connected realm by ID.
- Return type
dict
- async get_connected_realms_index()
Returns an index of connected realms.
- Returns
Returns an index of connected realms.
- Return type
dict
- async get_connected_realms_search(search_params: Optional[dict] = None)
Performs a search of connected realms. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of connected realms. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_covenant(covenant_id: int)
Returns a covenant by ID.
- Parameters
covenant_id (int) – The ID of the covenant.
- Returns
Returns a covenant by ID.
- Return type
dict
- async get_covenant_index()
Returns an index of covenants.
- Returns
Returns an index of covenants.
- Return type
dict
- async get_covenant_media(covenant_id: int)
Returns media for a covenant by ID.
- Parameters
covenant_id (int) – The ID of the covenant.
- Returns
Returns media for a covenant by ID.
- Return type
dict
- async get_creature(creature_id: int)
Returns a creature by ID.
- Parameters
creature_id (int) – The ID of the creature.
- Returns
Returns a creature by ID.
- Return type
dict
- async get_creature_display_media(creature_display_id: int)
Returns media for a creature display by ID.
- Parameters
creature_display_id (int) – The ID of the creature display.
- Returns
Returns media for a creature display by ID.
- Return type
dict
- async get_creature_families_index()
Returns an index of creature families.
- Returns
Returns an index of creature families.
- Return type
dict
- async get_creature_family(creature_family_id: int)
Returns a creature family by ID.
- Parameters
creature_family_id (int) – The ID of the creature family.
- Returns
Returns a creature family by ID.
- Return type
dict
- async get_creature_family_media(creature_family_id: int)
Returns media for a creature family by ID.
- Parameters
creature_family_id (int) – The ID of the creature family.
- Returns
Returns media for a creature family by ID.
- Return type
dict
- async get_creature_search(search_params: Optional[dict] = None)
Performs a search of creatures. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of creatures. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_creature_type(creature_type_id: int)
Returns a creature type by ID.
- Parameters
creature_type_id (int) – The ID of the creature type.
- Returns
Returns a creature type by ID.
- Return type
dict
- async get_creature_types_index()
Returns an index of creature types.
- Returns
Returns an index of creature types.
- Return type
dict
- async get_game_api_resource(namespace: str, endpoint: str, params: Optional[dict] = None) Optional[dict]
Generic method for retrieving data from a Game Data 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
- async get_guild_crest_border_media(border_id: int)
Returns media for a guild crest border by ID.
- Parameters
border_id (int) – The ID of the guild crest border.
- Returns
Returns media for a guild crest border by ID.
- Return type
dict
- async get_guild_crest_components_index()
Returns an index of guild crest media.
- Returns
Returns an index of guild crest media.
- Return type
dict
- async get_guild_crest_emblem_media(emblem_id: int)
Returns media for a guild crest emblem by ID.
- Parameters
emblem_id (int) – The ID of the guild crest emblem.
- Returns
Returns media for a guild crest emblem by ID.
- Return type
dict
- async get_item(item_id: str)
Returns an item by ID.
- Parameters
item_id (str) – The ID of the item.
- Returns
Returns an item by ID.
- Return type
dict
- async get_item_class(item_class_id: str)
Returns an item class by ID.
- Parameters
item_class_id (str) – The ID of the item class.
- Returns
Returns an item class by ID.
- Return type
dict
- async get_item_classes_index()
Returns an index of item classes.
- Returns
Returns an index of item classes.
- Return type
dict
- async get_item_media(item_id: int)
Returns media for an item by ID.
- Parameters
item_id (int) – The ID of the item.
- Returns
Returns media for an item by ID.
- Return type
dict
- async get_item_search(search_params: Optional[dict] = None)
Performs a search of items. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of items. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_item_set(item_set_id: int)
Returns an item set by ID.
- Parameters
item_set_id (int) – The ID of the item set.
- Returns
Returns an item set by ID.
- Return type
dict
- async get_item_sets_index()
Returns an index of item sets.
- Returns
Returns an index of item sets.
- Return type
dict
- async get_item_subclass(item_class_id: str, item_subclass_id: str)
Returns an item subclass by ID.
- Parameters
item_class_id (str) – The ID of the item class.
item_subclass_id (str) – The ID of the item subclass.
- Returns
Returns an item subclass by ID.
- Return type
dict
- async get_journal_encounter(journal_encounter_id: int)
Returns a journal encounter by ID.
- Parameters
journal_encounter_id (int) – The ID of the journal encounter.
- Returns
Returns a journal encounter by ID.
- Return type
dict
- async get_journal_encounter_search(search_params: Optional[dict] = None)
Performs a search of journal encounters. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of journal encounters. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_journal_encounters_index()
Returns an index of journal encounters.
- Returns
Returns an index of journal encounters.
- Return type
dict
- async get_journal_expansion(journal_expansion_id: int)
Returns a journal expansion by ID.
- Parameters
journal_expansion_id (int) – The ID of the journal expansion.
- Returns
Returns a journal expansion by ID.
- Return type
dict
- async get_journal_expansions_index()
Returns an index of journal expansions.
- Returns
Returns an index of journal expansions.
- Return type
dict
- async get_journal_instance(journal_instance_id: int)
Returns a journal instance.
- Parameters
journal_instance_id (int) – The ID of the journal instance.
- Returns
Returns a journal instance.
- Return type
dict
- async get_journal_instance_media(journal_instance_id: int)
Returns media for a journal instance by ID.
- Parameters
journal_instance_id (int) – The ID of the journal instance.
- Returns
Returns media for a journal instance by ID.
- Return type
dict
- async get_journal_instances_index()
Returns an index of journal instances.
- Returns
Returns an index of journal instances.
- Return type
dict
- async get_media_search(search_params: Optional[dict] = None)
Performs a search of all types of media documents. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of all types of media documents. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_modified_crafting_category(category_id: int)
Returns a Modified Crafting category by ID.
- Parameters
category_id (int) – The ID of the Modified Crafting category.
- Returns
Returns a Modified Crafting category by ID.
- Return type
dict
- async get_modified_crafting_category_index()
Returns the index of Modified Crafting categories.
- Returns
Returns the index of Modified Crafting categories.
- Return type
dict
- async get_modified_crafting_index()
Returns the parent index for Modified Crafting.
- Returns
Returns the parent index for Modified Crafting.
- Return type
dict
- async get_modified_crafting_reagent_slot_type(slot_type_id: int)
Returns a Modified Crafting reagent slot type by ID.
- Parameters
slot_type_id (int) – The ID of the Modified Crafting reagent slot type.
- Returns
Returns a Modified Crafting reagent slot type by ID.
- Return type
dict
- async get_modified_crafting_reagent_slot_type_index()
Returns the index of Modified Crafting reagent slot types.
- Returns
Returns the index of Modified Crafting reagent slot types.
- Return type
dict
- async get_mount(mount_id: int)
Returns a mount by ID.
- Parameters
mount_id (int) – The ID of the mount.
- Returns
Returns a mount by ID.
- Return type
dict
- async get_mount_search(search_params: Optional[dict] = None)
Performs a search of mounts. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of mounts. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_mounts_index()
Returns an index of mounts.
- Returns
Returns an index of mounts.
- Return type
dict
- async get_mythic_keystone_affix(keystone_affix_id: int)
Returns a mythic keystone affix by ID.
- Parameters
keystone_affix_id (int) – The ID of the mythic keystone affix.
- Returns
Returns a mythic keystone affix by ID.
- Return type
dict
- async get_mythic_keystone_affix_media(keystone_affix_id: int)
Returns media for a mythic keystone affix by ID.
- Parameters
keystone_affix_id (int) – The ID of the mythic keystone affix.
- Returns
Returns media for a mythic keystone affix by ID.
- Return type
dict
- async get_mythic_keystone_affixes_index()
Returns an index of mythic keystone affixes.
- Returns
Returns an index of mythic keystone affixes.
- Return type
dict
- async get_mythic_keystone_dungeon(dungeon_id: int)
Returns a Mythic Keystone dungeon by ID.
- Parameters
dungeon_id (int) – The ID of the dungeon.
- Returns
Returns a Mythic Keystone dungeon by ID.
- Return type
dict
- async get_mythic_keystone_dungeons_index()
Returns an index of Mythic Keystone dungeons.
- Returns
Returns an index of Mythic Keystone dungeons.
- Return type
dict
- async get_mythic_keystone_index()
Returns an index of links to other documents related to Mythic Keystone dungeons.
- Returns
Returns an index of links to other documents related to Mythic Keystone dungeons.
- Return type
dict
- async get_mythic_keystone_leaderboard(connected_realm_id: int, dungeon_id: int, period: int)
Returns a weekly Mythic Keystone Leaderboard by period.
- Parameters
connected_realm_id (int) – The ID of the connected realm.
dungeon_id (int) – The ID of the dungeon.
period (int) – The unique identifier for the leaderboard period.
- Returns
Returns a weekly Mythic Keystone Leaderboard by period.
- Return type
dict
- async get_mythic_keystone_leaderboards_index(connected_realm_id: int)
Returns an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
- Parameters
connected_realm_id (int) – The ID of the connected realm.
- Returns
Returns an index of Mythic Keystone Leaderboard dungeon instances for a connected realm.
- Return type
dict
- async get_mythic_keystone_period(period_id: int)
Returns a Mythic Keystone period by ID.
- Parameters
period_id (int) – The ID of the Mythic Keystone season period.
- Returns
Returns a Mythic Keystone period by ID.
- Return type
dict
- async get_mythic_keystone_periods_index()
Returns an index of Mythic Keystone periods.
- Returns
Returns an index of Mythic Keystone periods.
- Return type
dict
- async get_mythic_keystone_season(season_id: int)
Returns a Mythic Keystone season by ID.
- Parameters
season_id (int) – The ID of the Mythic Keystone season.
- Returns
Returns a Mythic Keystone season by ID.
- Return type
dict
- async get_mythic_keystone_seasons_index()
Returns an index of Mythic Keystone seasons.
- Returns
Returns an index of Mythic Keystone seasons.
- Return type
dict
- async get_mythic_raid_leaderboard(raid: str, faction: str)
Returns the leaderboard for a given raid and faction.
- Parameters
raid (str) – The raid for a leaderboard.
faction (str) – Player faction (alliance or horde).
- Returns
Returns the leaderboard for a given raid and faction.
- Return type
dict
- async get_pet(pet_id: int)
Returns a battle pets by ID.
- Parameters
pet_id (int) – The ID of the pet.
- Returns
Returns a battle pets by ID.
- Return type
dict
- async get_pet_abilities_index()
Returns an index of pet abilities.
- Returns
Returns an index of pet abilities.
- Return type
dict
- async get_pet_ability(pet_ability_id: int)
Returns a pet ability by ID.
- Parameters
pet_ability_id (int) – The ID of the pet ability.
- Returns
Returns a pet ability by ID.
- Return type
dict
- async get_pet_ability_media(pet_ability_id: int)
Returns media for a pet ability by ID.
- Parameters
pet_ability_id (int) – The ID of the pet ability.
- Returns
Returns media for a pet ability by ID.
- Return type
dict
- async get_pet_media(pet_id: int)
Returns media for a battle pet by ID.
- Parameters
pet_id (int) – The ID of the pet.
- Returns
Returns media for a battle pet by ID.
- Return type
dict
- async get_pets_index()
Returns an index of battle pets.
- Returns
Returns an index of battle pets.
- Return type
dict
- async get_playable_class(class_id: int)
Returns a playable class by ID.
- Parameters
class_id (int) – The ID of the playable class.
- Returns
Returns a playable class by ID.
- Return type
dict
- async get_playable_class_media(playable_class_id: int)
Returns media for a playable class by ID.
- Parameters
playable_class_id (int) – The ID of the playable class.
- Returns
Returns media for a playable class by ID.
- Return type
dict
- async get_playable_classes_index()
Returns an index of playable classes.
- Returns
Returns an index of playable classes.
- Return type
dict
- async get_playable_race(playable_race_id: int)
Returns a playable race by ID.
- Parameters
playable_race_id (int) – The ID of the playable race.
- Returns
Returns a playable race by ID.
- Return type
dict
- async get_playable_races_index()
Returns an index of playable races.
- Returns
Returns an index of playable races.
- Return type
dict
- async get_playable_specialization(spec_id: int)
Returns a playable specialization by ID.
- Parameters
spec_id (int) – The ID of the playable specialization.
- Returns
Returns a playable specialization by ID.
- Return type
dict
- async get_playable_specialization_media(spec_id: int)
Returns media for a playable specialization by ID.
- Parameters
spec_id (int) – The ID of the playable specialization.
- Returns
Returns media for a playable specialization by ID.
- Return type
dict
- async get_playable_specializations_index()
Returns an index of playable specializations.
- Returns
Returns an index of playable specializations.
- Return type
dict
- async get_power_type(power_type_id: int)
Returns a power type by ID.
- Parameters
power_type_id (int) – The ID of the power type.
- Returns
Returns a power type by ID.
- Return type
dict
- async get_power_types_index()
Returns an index of power types.
- Returns
Returns an index of power types.
- Return type
dict
- async get_profession(profession_id: int)
Returns a profession by ID.
- Parameters
profession_id (int) – The ID of the profession.
- Returns
Returns a profession by ID.
- Return type
dict
- async get_profession_media(profession_id: int)
Returns media for a profession by ID.
- Parameters
profession_id (int) – The ID of the profession.
- Returns
Returns media for a profession by ID.
- Return type
dict
- async get_profession_skill_tier(profession_id: int, skill_tier_id: int)
Returns a skill tier for a profession by ID.
- Parameters
profession_id (int) – The ID of the profession.
skill_tier_id (int) – The ID of the skill tier.
- Returns
Returns a skill tier for a profession by ID.
- Return type
dict
- async get_professions_index()
Returns an index of professions.
- Returns
Returns an index of professions.
- Return type
dict
- async get_pvp_leaderboard(pvp_season_id: int, pvp_bracket: str)
Returns the PvP leaderboard of a specific PvP bracket for a PvP season.
- Parameters
pvp_season_id (int) – The ID of the PvP season.
pvp_bracket (str) – The PvP bracket type.
- Returns
Returns the PvP leaderboard of a specific PvP bracket for a PvP season.
- Return type
dict
- async get_pvp_leaderboards_index(pvp_season_id: int)
Returns an index of PvP leaderboards for a PvP season.
- Parameters
pvp_season_id (int) – The ID of the PvP season.
- Returns
Returns an index of PvP leaderboards for a PvP season.
- Return type
dict
- async get_pvp_rewards_index(pvp_season_id: int)
Returns an index of PvP rewards for a PvP season.
- Parameters
pvp_season_id (int) – The ID of the PvP season.
- Returns
Returns an index of PvP rewards for a PvP season.
- Return type
dict
- async get_pvp_season(pvp_season_id: int)
Returns a PvP season by ID.
- Parameters
pvp_season_id (int) – The ID of the PvP season.
- Returns
Returns a PvP season by ID.
- Return type
dict
- async get_pvp_seasons_index()
Returns an index of PvP seasons.
- Returns
Returns an index of PvP seasons.
- Return type
dict
- async get_pvp_talent(pvp_talent_id: int)
Returns a PvP talent by ID.
- Parameters
pvp_talent_id (int) – The ID of the PvP talent.
- Returns
Returns a PvP talent by ID.
- Return type
dict
- async get_pvp_talent_slots(class_id: int)
Returns the PvP talent slots for a playable class by ID.
- Parameters
class_id (int) – The ID of the playable class.
- Returns
Returns the PvP talent slots for a playable class by ID.
- Return type
dict
- async get_pvp_talents_index()
Returns an index of PvP talents.
- Returns
Returns an index of PvP talents.
- Return type
dict
- async get_pvp_tier(pvp_tier_id: int)
Returns a PvP tier by ID.
- Parameters
pvp_tier_id (int) – The ID of the PvP tier.
- Returns
Returns a PvP tier by ID.
- Return type
dict
- async get_pvp_tier_media(pvp_tier_id: int)
Returns media for a PvP tier by ID.
- Parameters
pvp_tier_id (int) – The ID of the PvP tier.
- Returns
Returns media for a PvP tier by ID.
- Return type
dict
- async get_pvp_tiers_index()
Returns an index of PvP tiers.
- Returns
Returns an index of PvP tiers.
- Return type
dict
- async get_quest(quest_id: int)
Returns a quest by ID.
- Parameters
quest_id (int) – The ID of the quest.
- Returns
Returns a quest by ID.
- Return type
dict
- async get_quest_area(quest_area_id: str)
Returns a quest area by ID.
- Parameters
quest_area_id (str) – The ID of the quest area.
- Returns
Returns a quest area by ID.
- Return type
dict
- async get_quest_areas_index()
Returns an index of quest areas.
- Returns
Returns an index of quest areas.
- Return type
dict
- async get_quest_categories_index()
Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
- Returns
Returns an index of quest categories (such as quests for a specific class, profession, or storyline).
- Return type
dict
- async get_quest_category(quest_category_id: str)
Returns a quest category by ID.
- Parameters
quest_category_id (str) – The ID of the quest category.
- Returns
Returns a quest category by ID.
- Return type
dict
- async get_quest_type(quest_type_id: str)
Returns a quest type by ID.
- Parameters
quest_type_id (str) – The ID of the quest type.
- Returns
Returns a quest type by ID.
- Return type
dict
- async get_quest_types_index()
Returns an index of quest types (such as PvP quests, raid quests, or account quests).
- Returns
Returns an index of quest types (such as PvP quests, raid quests, or account quests).
- Return type
dict
- async get_quests_index()
Returns the parent index for quests.
- Returns
Returns the parent index for quests.
- Return type
dict
- async get_realm(realm_slug: str)
Returns a single realm by slug or ID.
- Parameters
realm_slug (str) – The slug of the realm.
- Returns
Returns a single realm by slug or ID.
- Return type
dict
- async get_realm_search(search_params: Optional[dict] = None)
Performs a search of realms. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of realms. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_realms_index()
Returns an index of realms.
- Returns
Returns an index of realms.
- Return type
dict
- async get_recipe(recipe_id: int)
Returns a recipe by ID.
- Parameters
recipe_id (int) – The ID of the recipe.
- Returns
Returns a recipe by ID.
- Return type
dict
- async get_recipe_media(recipe_id: int)
Returns media for a recipe by ID.
- Parameters
recipe_id (int) – The ID of the recipe.
- Returns
Returns media for a recipe by ID.
- Return type
dict
- async get_region(region_id: int)
Returns a region by ID.
- Parameters
region_id (int) – The ID of the region.
- Returns
Returns a region by ID.
- Return type
dict
- async get_regions_index()
Returns an index of regions.
- Returns
Returns an index of regions.
- Return type
dict
- async get_reputation_faction(reputation_faction_id: int)
Returns a single reputation faction by ID.
- Parameters
reputation_faction_id (int) – The ID of the reputation faction.
- Returns
Returns a single reputation faction by ID.
- Return type
dict
- async get_reputation_factions_index()
Returns an index of reputation factions.
- Returns
Returns an index of reputation factions.
- Return type
dict
- async get_reputation_tiers(reputation_tiers_id: int)
Returns a single set of reputation tiers by ID.
- Parameters
reputation_tiers_id (int) – The ID of the set of reputation tiers.
- Returns
Returns a single set of reputation tiers by ID.
- Return type
dict
- async get_reputation_tiers_index()
Returns an index of reputation tiers.
- Returns
Returns an index of reputation tiers.
- Return type
dict
- async get_soulbind(soulbind_id: int)
Returns a soulbind by ID.
- Parameters
soulbind_id (int) – The ID of the soulbind.
- Returns
Returns a soulbind by ID.
- Return type
dict
- async get_soulbind_index()
Returns an index of soulbinds.
- Returns
Returns an index of soulbinds.
- Return type
dict
- async get_spell(spell_id: int)
Returns a spell by ID.
- Parameters
spell_id (int) – The ID of the spell.
- Returns
Returns a spell by ID.
- Return type
dict
- async get_spell_media(spell_id: int)
Returns media for a spell by ID.
- Parameters
spell_id (int) – The ID of the spell.
- Returns
Returns media for a spell by ID.
- Return type
dict
- async get_spell_search(search_params: Optional[dict] = None)
Performs a search of spells. The fields below are provided for example. For more detail see the Search Guide.
- Parameters
search_params (dict) – Search parameters
- Returns
Performs a search of spells. The fields below are provided for example. For more detail see the Search Guide.
- Return type
dict
- async get_talent(talent_id: int)
Returns a talent by ID.
- Parameters
talent_id (int) – The ID of the talent.
- Returns
Returns a talent by ID.
- Return type
dict
- async get_talent_tree(talent_tree_id: int, spec_id: int)
Returns a talent tree by specialization ID.
- Parameters
talent_tree_id (int) – The ID of the talent-tree.
spec_id (int) – The ID of the playable-specialization.
- Returns
Returns a talent tree by specialization ID.
- Return type
dict
- async get_talent_tree_index()
Returns an index of talent trees.
- Returns
Returns an index of talent trees.
- Return type
dict
- async get_talents_index()
Returns an index of talents.
- Returns
Returns an index of talents.
- Return type
dict
- async get_tech_talent(tech_talent_id: int)
Returns a tech talent by ID.
- Parameters
tech_talent_id (int) – The ID of the tech talent.
- Returns
Returns a tech talent by ID.
- Return type
dict
- async get_tech_talent_index()
Returns an index of tech talents.
- Returns
Returns an index of tech talents.
- Return type
dict
- async get_tech_talent_media(tech_talent_id: int)
Returns media for a tech talent by ID.
- Parameters
tech_talent_id (int) – The ID of the tech talent.
- Returns
Returns media for a tech talent by ID.
- Return type
dict
- async get_tech_talent_tree(tech_talent_tree_id: int)
Returns a tech talent tree by ID.
- Parameters
tech_talent_tree_id (int) – The ID of the tech talent tree.
- Returns
Returns a tech talent tree by ID.
- Return type
dict
- async get_tech_talent_tree_index()
Returns an index of tech talent trees.
- Returns
Returns an index of tech talent trees.
- Return type
dict
- async get_title(title_id: int)
Returns a title by ID.
- Parameters
title_id (int) – The ID of the title.
- Returns
Returns a title by ID.
- Return type
dict
- async get_titles_index()
Returns an index of titles.
- Returns
Returns an index of titles.
- Return type
dict
- async get_wow_token_index()
Returns the WoW Token index.
- Returns
Returns the WoW Token index.
- Return type
dict
- async get_wow_token_index_cn()
Returns the WoW Token index.
- Returns
Returns the WoW Token index.
- Return type
dict