aiowowapi.classic.game_data_classic module

class aiowowapi.classic.game_data_classic.GameData(api)

Bases: object

This class contains all API endpoints for the GameData category of the Classic World of Warcraft API

Parameters: api (API) – An instance of our generic API object

async get_auction_house_index(connected_realm_id: int)

Returns an index of auction houses for a connected realm.

See the Connected Realm API for information about retrieving a list of connected realm IDs.

param connected_realm_id

The ID of the connected realm.

type connected_realm_id

int

return

Returns an index of auction houses for a connected realm.

rtype

dict

async get_auctions(connected_realm_id: int, auction_house_id: int)

Returns all active auctions for a specific auction house on 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

param auction_house_id

The ID of the auction house.

type auction_house_id

int

return

Returns all active auctions for a specific auction house on a connected realm.

rtype

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_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_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_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_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_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_pvp_leaderboard(pvp_region_id: int, pvp_season_id: int, pvp_bracket: str)

Returns the PvP leaderboard of a specific PvP bracket for a PvP season in a given PvP region.

Parameters

pvp_region_id (int) – The ID of the PvP region.
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 in a given PvP region.

Return type

dict

async get_pvp_leaderboards_index(pvp_region_id: int, pvp_season_id: int)

Returns an index of PvP leaderboards for a PvP season in a given PvP region.

Parameters

pvp_region_id (int) – The ID of the PvP region.
pvp_season_id (int) – The ID of the PvP season.

Returns

Returns an index of PvP leaderboards for a PvP season in a given PvP region.

Return type

dict

async get_pvp_region_index()

Returns an index of PvP Regions.

Returns: Returns an index of PvP Regions.
Return type: dict

async get_pvp_regional_season(pvp_region_id: int, pvp_season_id: int)

Returns a PvP season by region ID and season ID.

Parameters

pvp_region_id (int) – The ID of the PvP region.
pvp_season_id (int) – The ID of the PvP season.

Returns

Returns a PvP season by region ID and season ID.

Return type

dict

async get_pvp_regional_season_index(pvp_region_id: int)

Returns an index of PvP Seasons in a PvP region.

Parameters: pvp_region_id (int) – The ID of the PvP region.
Returns: Returns an index of PvP Seasons in a PvP region.
Return type: dict

async get_pvp_rewards_index(pvp_region_id: int, pvp_season_id: int)

Returns an index of PvP rewards for a PvP season in a given PvP region.

Parameters

pvp_region_id (int) – The ID of the PvP region.
pvp_season_id (int) – The ID of the PvP season.

Returns

Returns an index of PvP rewards for a PvP season in a given PvP region.

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_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 examples only. For more detail see the Search Guide.

Parameters: search_params (dict) – Search parameters
Returns: Performs a search of realms. The fields below are examples only. 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_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_wow_token_index_cn()

Returns the WoW Token index.

Returns: Returns the WoW Token index.
Return type: dict