@blizzard-api/classic-wow
Version:
A series of helpers to interact with the World of Warcraft Classic Blizzard API
35 lines (34 loc) • 1.43 kB
JavaScript
import { wowBasePath } from "@blizzard-api/core";
//#region src/auction-house/index.ts
/**
* Returns an index of auction houses for a connected realm.
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param connectedRealmId The ID of the connected realm.
* @returns The auction house index. See {@link AuctionHouseIndexResponse}.
*/
function auctionHouseIndex(namespace, connectedRealmId) {
return {
namespace,
path: `${wowBasePath}/connected-realm/${connectedRealmId}/auctions/index`
};
}
/**
* Returns all active auctions for a specific auction house on 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.
*
* 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 namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param connectedRealmId The ID of the connected realm.
* @param auctionHouseId The ID of the auction house.
* @returns The auction house data. See {@link AuctionsResponse}.
*/
function auctions(namespace, connectedRealmId, auctionHouseId) {
return {
namespace,
path: `${wowBasePath}/connected-realm/${connectedRealmId}/auctions/${auctionHouseId}`
};
}
//#endregion
export { auctionHouseIndex, auctions };
//# sourceMappingURL=index.js.map