Skip to content

Documentation


Documentation / @blizzard-api/classic-wow / auctions

Function: auctions() ​

auctions(namespace, connectedRealmId, auctionHouseId): object

Defined in: classic-wow/src/auction-house/index.ts:31

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.

Parameters ​

namespace ​

"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"

The namespace to use. See DynamicClassicNamespaces.

connectedRealmId ​

number

The ID of the connected realm.

auctionHouseId ​

number

The ID of the auction house.

Returns ​

The auction house data. See AuctionsResponse.

_responseType? ​

optional _responseType?: AuctionsResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: Record<string, unknown>

path ​

path: string

The request path. Dynamic path segments should be encoded with encodeURIComponent.