@pinta365/blizzard_api 0.4.0 → 0.5.0

package/esm/src/starcraft2/community/profile.d.ts

@@ -0,0 +1,255 @@
+/**
+ * This module provides the StarCraft II profile endpoints (static, metadata, profile, ladder summary and ladder) using
+ * the Blizzard API.
+ */
+import type { ApiContext } from "../../shared/index.js";
+export interface Sc2StaticAchievement {
+    categoryId: string;
+    chainAchievementIds: string[];
+    chainRewardSize: number;
+    criteriaIds: string[];
+    description: string;
+    flags: number;
+    id: string;
+    imageUrl: string;
+    isChained: boolean;
+    points: number;
+    title: string;
+    uiOrderHint: number;
+}
+export interface Sc2StaticCriterion {
+    achievementId: string;
+    description: string;
+    evaluationClass: string;
+    flags: number;
+    id: string;
+    necessaryQuantity: number;
+    uiOrderHint: number;
+}
+export interface Sc2StaticCategory {
+    childrenCategoryIds: string[];
+    featuredAchievementId: string;
+    id: string;
+    name: string;
+    parentCategoryId: string;
+    points: number;
+    uiOrderHint: number;
+    medalTiers: number[];
+}
+export interface Sc2StaticReward {
+    flags: number;
+    id: string;
+    achievementId: string;
+    name: string;
+    imageUrl: string;
+    unlockableType: string;
+    isSkin: boolean;
+    uiOrderHint: number;
+    command?: string;
+}
+export interface Sc2StaticProfile {
+    achievements: Sc2StaticAchievement[];
+    criteria: Sc2StaticCriterion[];
+    categories: Sc2StaticCategory[];
+    rewards: Sc2StaticReward[];
+}
+export interface Sc2ProfileMetadata {
+    name: string;
+    profileUrl: string;
+    avatarUrl: string;
+    profileId: string;
+    regionId: number;
+    realmId: number;
+}
+export interface Sc2ProfileSummary {
+    id: string;
+    realm: number;
+    displayName: string;
+    clanName: string;
+    clanTag: string;
+    portrait: string;
+    decalTerran: string;
+    decalProtoss: string;
+    decalZerg: string;
+    totalSwarmLevel: number;
+    totalAchievementPoints: number;
+}
+export interface Sc2SeasonSnapshotEntry {
+    rank: number;
+    leagueName: string | null;
+    totalGames: number;
+    totalWins: number;
+}
+export interface Sc2Career {
+    terranWins: number;
+    zergWins: number;
+    protossWins: number;
+    totalCareerGames: number;
+    totalGamesThisSeason: number;
+    current1v1LeagueName: string | null;
+    currentBestTeamLeagueName: string | null;
+    best1v1Finish: {
+        leagueName: string | null;
+        timesAchieved: number;
+    };
+    bestTeamFinish: {
+        leagueName: string | null;
+        timesAchieved: number;
+    };
+}
+export interface Sc2SwarmLevel {
+    level: number;
+    maxLevelPoints: number;
+    currentLevelPoints: number;
+}
+export interface Sc2SwarmLevels {
+    level: number;
+    terran: Sc2SwarmLevel;
+    zerg: Sc2SwarmLevel;
+    protoss: Sc2SwarmLevel;
+}
+export interface Sc2CategoryPointProgress {
+    categoryId: string;
+    pointsEarned: number;
+}
+export interface Sc2EarnedReward {
+    rewardId: string;
+    selected: boolean;
+    achievementId?: string;
+    category?: string;
+}
+export interface Sc2EarnedAchievement {
+    achievementId: string;
+    completionDate: number;
+    numCompletedAchievementsInSeries: number;
+    totalAchievementsInSeries: number;
+    isComplete: boolean;
+    inProgress: boolean;
+    criteria: unknown[];
+    nextProgressEarnedQuantity?: number;
+    nextProgressRequiredQuantity?: number;
+}
+export interface Sc2PlayerProfile {
+    summary: Sc2ProfileSummary;
+    snapshot: {
+        seasonSnapshot: Record<string, Sc2SeasonSnapshotEntry>;
+        totalRankedSeasonGamesPlayed: number;
+    };
+    career: Sc2Career;
+    swarmLevels: Sc2SwarmLevels;
+    campaign: Record<string, unknown>;
+    categoryPointProgress: Sc2CategoryPointProgress[];
+    achievementShowcase: unknown[];
+    earnedRewards: Sc2EarnedReward[];
+    earnedAchievements: Sc2EarnedAchievement[];
+}
+export interface Sc2LadderTeamMember {
+    id: string;
+    realm: number;
+    region: number;
+    displayName: string;
+    clanTag?: string;
+    favoriteRace: string;
+}
+export interface Sc2LadderTeam {
+    teamMembers: Sc2LadderTeamMember[];
+    previousRank: number;
+    points: number;
+    wins: number;
+    losses: number;
+    mmr: number;
+    joinTimestamp: number;
+}
+export interface Sc2LadderMembership {
+    ladderId: string;
+    localizedGameMode: string;
+    rank: number;
+}
+export interface Sc2LadderShowcaseEntry {
+    ladderId: string;
+    team: {
+        localizedGameMode: string;
+        members: {
+            favoriteRace: string;
+            name: string;
+            playerId: string;
+            region: number;
+        }[];
+    };
+    leagueName: string;
+    localizedDivisionName: string;
+    rank: number;
+    wins: number;
+    losses: number;
+}
+export interface Sc2PlacementMatch {
+    localizedGameMode: string;
+    members: {
+        name: string;
+        playerId: string;
+        region: number;
+    }[];
+    gamesRemaining: number;
+}
+export interface Sc2LadderSummary {
+    showCaseEntries: Sc2LadderShowcaseEntry[];
+    placementMatches: Sc2PlacementMatch[];
+    allLadderMemberships: Sc2LadderMembership[];
+}
+export interface Sc2Ladder {
+    ladderTeams: Sc2LadderTeam[];
+    allLadderMemberships: Sc2LadderMembership[];
+    league: string;
+    currentLadderMembership: {
+        ladderId: string;
+        localizedGameMode: string;
+    };
+    ranksAndPools: {
+        rank: number;
+        mmr: number;
+    }[];
+}
+/**
+ * Returns the static StarCraft II profile data (achievements, criteria, categories and rewards) for a region.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @returns A promise that resolves to an object representing the static profile data.
+ */
+export declare function staticProfile(ctx: ApiContext, regionId: number): Promise<Sc2StaticProfile>;
+/**
+ * Returns the metadata of a StarCraft II profile.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @returns A promise that resolves to an object representing the profile metadata.
+ */
+export declare function metadataProfile(ctx: ApiContext, regionId: number, realmId: number, profileId: number): Promise<Sc2ProfileMetadata>;
+/**
+ * Returns a StarCraft II profile.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @returns A promise that resolves to an object representing the profile.
+ */
+export declare function profile(ctx: ApiContext, regionId: number, realmId: number, profileId: number): Promise<Sc2PlayerProfile>;
+/**
+ * Returns the ladder summary of a StarCraft II profile.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @returns A promise that resolves to an object representing the ladder summary.
+ */
+export declare function ladderSummary(ctx: ApiContext, regionId: number, realmId: number, profileId: number): Promise<Sc2LadderSummary>;
+/**
+ * Returns a StarCraft II ladder.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @param ladderId - The unique identifier for the ladder.
+ * @returns A promise that resolves to an object representing the ladder.
+ */
+export declare function ladder(ctx: ApiContext, regionId: number, realmId: number, profileId: number, ladderId: string): Promise<Sc2Ladder>;

package/esm/src/starcraft2/community/profile.js

@@ -0,0 +1,73 @@
+/**
+ * This module provides the StarCraft II profile endpoints (static, metadata, profile, ladder summary and ladder) using
+ * the Blizzard API.
+ */
+/**
+ * Returns the static StarCraft II profile data (achievements, criteria, categories and rewards) for a region.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @returns A promise that resolves to an object representing the static profile data.
+ */
+export async function staticProfile(ctx, regionId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/sc2/static/profile/${regionId}`,
+    });
+}
+/**
+ * Returns the metadata of a StarCraft II profile.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @returns A promise that resolves to an object representing the profile metadata.
+ */
+export async function metadataProfile(ctx, regionId, realmId, profileId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/sc2/metadata/profile/${regionId}/${realmId}/${profileId}`,
+    });
+}
+/**
+ * Returns a StarCraft II profile.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @returns A promise that resolves to an object representing the profile.
+ */
+export async function profile(ctx, regionId, realmId, profileId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/sc2/profile/${regionId}/${realmId}/${profileId}`,
+    });
+}
+/**
+ * Returns the ladder summary of a StarCraft II profile.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @returns A promise that resolves to an object representing the ladder summary.
+ */
+export async function ladderSummary(ctx, regionId, realmId, profileId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/sc2/profile/${regionId}/${realmId}/${profileId}/ladder/summary`,
+    });
+}
+/**
+ * Returns a StarCraft II ladder.
+ *
+ * @param regionId - The region: 1=US, 2=EU, 3=KR/TW, 5=CN.
+ * @param realmId - The realm: 1 or 2.
+ * @param profileId - The unique identifier for the profile.
+ * @param ladderId - The unique identifier for the ladder.
+ * @returns A promise that resolves to an object representing the ladder.
+ */
+export async function ladder(ctx, regionId, realmId, profileId, ladderId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/sc2/profile/${regionId}/${realmId}/${profileId}/ladder/${ladderId}`,
+    });
+}

package/esm/src/starcraft2/game_data/league.d.ts

@@ -0,0 +1,35 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref } from "../../shared/index.js";
+export interface League extends LinkSelfHref {
+    key: {
+        league_id: number;
+        season_id: number;
+        queue_id: number;
+        team_type: number;
+    };
+    tier: {
+        id: number;
+        min_rating?: number;
+        max_rating?: number;
+        division: {
+            id: number;
+            ladder_id: number;
+            member_count: number;
+        }[];
+    }[];
+}
+/**
+ * Returns data for the specified season, queue, team, and league.
+ *
+ * Notes from the battle.net docs:
+ * queueId: the standard available queueIds are: 1=WoL 1v1, 2=WoL 2v2, 3=WoL 3v3, 4=WoL 4v4, 101=HotS 1v1, 102=HotS 2v2, 103=HotS 3v3, 104=HotS 4v4, 201=LotV 1v1, 202=LotV 2v2, 203=LotV 3v3, 204=LotV 4v4, 206=LotV Archon. Note that other available queues may not be listed here.
+ * teamType: there are two available teamTypes: 0=arranged, 1=random.
+ * leagueId: available leagueIds are: 0=Bronze, 1=Silver, 2=Gold, 3=Platinum, 4=Diamond, 5=Master, 6=Grandmaster.
+ *
+ * @param seasonId - The season ID of the data to retrieve.
+ * @param queueId - The queue ID of the data to retrieve.
+ * @param teamType - The team type of the data to retrieve.
+ * @param leagueId - The league ID of the data to retrieve.
+ * @returns A promise that resolves to an object representing the data for a league.
+ */
+export declare function leagueData(ctx: ApiContext, seasonId: number, queueId: number, teamType: number, leagueId: number): Promise<League>;

package/esm/src/starcraft2/game_data/league.js

@@ -0,0 +1,20 @@
+/**
+ * Returns data for the specified season, queue, team, and league.
+ *
+ * Notes from the battle.net docs:
+ * queueId: the standard available queueIds are: 1=WoL 1v1, 2=WoL 2v2, 3=WoL 3v3, 4=WoL 4v4, 101=HotS 1v1, 102=HotS 2v2, 103=HotS 3v3, 104=HotS 4v4, 201=LotV 1v1, 202=LotV 2v2, 203=LotV 3v3, 204=LotV 4v4, 206=LotV Archon. Note that other available queues may not be listed here.
+ * teamType: there are two available teamTypes: 0=arranged, 1=random.
+ * leagueId: available leagueIds are: 0=Bronze, 1=Silver, 2=Gold, 3=Platinum, 4=Diamond, 5=Master, 6=Grandmaster.
+ *
+ * @param seasonId - The season ID of the data to retrieve.
+ * @param queueId - The queue ID of the data to retrieve.
+ * @param teamType - The team type of the data to retrieve.
+ * @param leagueId - The league ID of the data to retrieve.
+ * @returns A promise that resolves to an object representing the data for a league.
+ */
+export async function leagueData(ctx, seasonId, queueId, teamType, leagueId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/sc2/league/${seasonId}/${queueId}/${teamType}/${leagueId}`,
+    });
+}

package/esm/src/starcraft2/index.d.ts

@@ -0,0 +1,5 @@
+export { leagueData } from "./game_data/league.js";
+export { ladder, ladderSummary, metadataProfile, profile, staticProfile } from "./community/profile.js";
+export { grandmasterLeaderboard, season } from "./community/ladder.js";
+export { player } from "./community/account.js";
+export { legacyAchievements, legacyLadder, legacyLadders, legacyMatches, legacyProfile, legacyRewards, } from "./community/legacy.js";

package/esm/src/starcraft2/index.js

@@ -0,0 +1,5 @@
+export { leagueData } from "./game_data/league.js";
+export { ladder, ladderSummary, metadataProfile, profile, staticProfile } from "./community/profile.js";
+export { grandmasterLeaderboard, season } from "./community/ladder.js";
+export { player } from "./community/account.js";
+export { legacyAchievements, legacyLadder, legacyLadders, legacyMatches, legacyProfile, legacyRewards, } from "./community/legacy.js";

package/esm/src/starcraft2/types.d.ts

@@ -0,0 +1,5 @@
+export type { Sc2Player } from "./community/account.js";
+export type { Sc2GrandmasterLeaderboard, Sc2Season } from "./community/ladder.js";
+export type { Sc2LegacyAchievement, Sc2LegacyAchievementCategory, Sc2LegacyAchievements, Sc2LegacyAchievementsSummary, Sc2LegacyCareer, Sc2LegacyCharacter, Sc2LegacyIcon, Sc2LegacyLadder, Sc2LegacyLadderGroup, Sc2LegacyLadders, Sc2LegacyMatch, Sc2LegacyMatches, Sc2LegacyProfile, Sc2LegacyReward, Sc2LegacyRewards, Sc2LegacySeason, Sc2LegacySwarmLevel, Sc2LegacySwarmLevels, } from "./community/legacy.js";
+export type { Sc2Career, Sc2CategoryPointProgress, Sc2EarnedAchievement, Sc2EarnedReward, Sc2Ladder, Sc2LadderMembership, Sc2LadderShowcaseEntry, Sc2LadderSummary, Sc2LadderTeam, Sc2LadderTeamMember, Sc2PlacementMatch, Sc2PlayerProfile, Sc2ProfileMetadata, Sc2ProfileSummary, Sc2SeasonSnapshotEntry, Sc2StaticAchievement, Sc2StaticCategory, Sc2StaticCriterion, Sc2StaticProfile, Sc2StaticReward, Sc2SwarmLevel, Sc2SwarmLevels, } from "./community/profile.js";
+export type { League } from "./game_data/league.js";

package/esm/src/starcraft2/types.js

@@ -0,0 +1 @@
+export {};

package/esm/src/wow/game_data/achievement.d.ts

@@ -0,0 +1,87 @@
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft achievement data using the Blizzard API.
+ *
+ * @author Pinta <https://github.com/Pinta365>
+ */
+import type { ApiContext } from "../../shared/index.js";
+import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString, NamedRef } from "../../shared/index.js";
+export interface AchievementCategories extends LinkSelfHref {
+    categories: KeyNameId[];
+    root_categories: NamedRef[];
+    guild_categories: NamedRef[];
+}
+export interface AggregatesByFaction {
+    alliance: {
+        quantity: number;
+        points: number;
+    };
+    horde: {
+        quantity: number;
+        points: number;
+    };
+}
+export interface AchievementCategory extends LinkSelfHref {
+    id: number;
+    name: LocalizedString;
+    achievements?: KeyNameId[];
+    parent_category?: KeyNameId;
+    is_guild_category: boolean;
+    aggregates_by_faction: AggregatesByFaction;
+    display_order: number;
+}
+export interface Achievements extends LinkSelfHref {
+    achievements: KeyNameId[];
+}
+export interface Achievement extends LinkSelfHref {
+    id: number;
+    category: KeyNameId;
+    name: LocalizedString;
+    description: LocalizedString;
+    points: number;
+    is_account_wide: boolean;
+    criteria?: {
+        id: number;
+        description: LocalizedString;
+        amount: number;
+    };
+    next_achievement?: KeyNameId;
+    media: KeyId;
+    display_order: number;
+}
+export interface AchievementMedia extends LinkSelfHref {
+    assets: Asset[];
+    id: number;
+}
+/**
+ * Fetches and returns an index of achievement categories.
+ *
+ * @returns A promise that resolves to an object representing the index of achievement categories.
+ */
+export declare function achievementCategories(ctx: ApiContext): Promise<AchievementCategories>;
+/**
+ * Fetches and returns details of a specific achievement category identified by its ID.
+ *
+ * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
+ * @returns A promise that resolves to an object representing the achievement category details.
+ */
+export declare function achievementCategory(ctx: ApiContext, achievementCategoryId: number): Promise<AchievementCategory>;
+/**
+ * Fetches and returns an index of achievements.
+ *
+ * @returns A promise that resolves to an object representing the index of achievements.
+ */
+export declare function achievements(ctx: ApiContext): Promise<Achievements>;
+/**
+ * Fetches and returns details of a specific achievement identified by its ID.
+ *
+ * @param achievementId - The unique identifier of the achievement to retrieve.
+ * @returns A promise that resolves to an object representing the achievement details.
+ */
+export declare function achievement(ctx: ApiContext, achievementId: number): Promise<Achievement>;
+/**
+ * Fetches and returns media details for a specific achievement identified by its ID.
+ *
+ * @param achievementId - The unique identifier of the achievement to retrieve media details for.
+ * @returns A promise that resolves to an object representing the achievement media details.
+ */
+export declare function achievementMedia(ctx: ApiContext, achievementId: number): Promise<AchievementMedia>;

package/esm/src/wow/game_data/achievement.js

@@ -0,0 +1,68 @@
+/**
+ * This module provides interfaces and API function definitions for fetching World of Warcraft achievement data using the Blizzard API.
+ *
+ * @author Pinta <https://github.com/Pinta365>
+ */
+/**
+ * Fetches and returns an index of achievement categories.
+ *
+ * @returns A promise that resolves to an object representing the index of achievement categories.
+ */
+export async function achievementCategories(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/achievement-category/index",
+        namespace: "static",
+    });
+}
+/**
+ * Fetches and returns details of a specific achievement category identified by its ID.
+ *
+ * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
+ * @returns A promise that resolves to an object representing the achievement category details.
+ */
+export async function achievementCategory(ctx, achievementCategoryId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/achievement-category/${achievementCategoryId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Fetches and returns an index of achievements.
+ *
+ * @returns A promise that resolves to an object representing the index of achievements.
+ */
+export async function achievements(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/achievement/index",
+        namespace: "static",
+    });
+}
+/**
+ * Fetches and returns details of a specific achievement identified by its ID.
+ *
+ * @param achievementId - The unique identifier of the achievement to retrieve.
+ * @returns A promise that resolves to an object representing the achievement details.
+ */
+export async function achievement(ctx, achievementId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/achievement/${achievementId}`,
+        namespace: "static",
+    });
+}
+/**
+ * Fetches and returns media details for a specific achievement identified by its ID.
+ *
+ * @param achievementId - The unique identifier of the achievement to retrieve media details for.
+ * @returns A promise that resolves to an object representing the achievement media details.
+ */
+export async function achievementMedia(ctx, achievementId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/media/achievement/${achievementId}`,
+        namespace: "static",
+    });
+}

package/esm/src/wow/game_data/auction_house.d.ts

@@ -0,0 +1,65 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref } from "../../shared/index.js";
+export interface AuctionItem {
+    id: number;
+    modifiers?: {
+        type: number;
+        value: number;
+    }[];
+    pet_breed_id?: number;
+    pet_level?: number;
+    pet_quality_id?: number;
+    pet_species_id?: number;
+    bonus_lists?: number[];
+    context?: number;
+}
+export interface AuctionListing {
+    id: number;
+    item: AuctionItem;
+    bid?: number;
+    buyout?: number;
+    quantity: number;
+    time_left: string;
+}
+export interface Auctions extends LinkSelfHref {
+    connected_realm: {
+        href: string;
+    };
+    auctions: AuctionListing[];
+    commodities: {
+        href: string;
+    };
+}
+export interface commodity {
+    "id": number;
+    "item": {
+        "id": number;
+    };
+    "quantity": number;
+    "unit_price": number;
+    "time_left": string;
+}
+export interface Commodities extends LinkSelfHref {
+    auctions: commodity[];
+}
+/**
+ * Returns all active auctions for a connected realm.
+ *
+ * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
+ *
+ * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
+ *
+ * @param connectedRealmId - The id of the connected realm to return auctions from.
+ * @returns A promise that resolves to an object representing the auctions being listed.
+ */
+export declare function auctions(ctx: ApiContext, connectedRealmId: number): Promise<Auctions>;
+/**
+ * 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.
+ *
+ * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
+ *
+ * @returns A promise that resolves to an object representing the commodities being listed.
+ */
+export declare function commodities(ctx: ApiContext): Promise<Commodities>;

package/esm/src/wow/game_data/auction_house.js

@@ -0,0 +1,33 @@
+/**
+ * Returns all active auctions for a connected realm.
+ *
+ * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
+ *
+ * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
+ *
+ * @param connectedRealmId - The id of the connected realm to return auctions from.
+ * @returns A promise that resolves to an object representing the auctions being listed.
+ */
+export async function auctions(ctx, connectedRealmId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/wow/connected-realm/${connectedRealmId}/auctions`,
+        namespace: "dynamic",
+    });
+}
+/**
+ * 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.
+ *
+ * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
+ *
+ * @returns A promise that resolves to an object representing the commodities being listed.
+ */
+export async function commodities(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/wow/auctions/commodities",
+        namespace: "dynamic",
+    });
+}