Skip to content

Documentation


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

Function: auctionHouseIndex() ​

auctionHouseIndex(namespace, connectedRealmId): object

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

Returns an index of auction houses for a connected realm.

Parameters ​

namespace ​

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

The namespace to use. See DynamicClassicNamespaces.

connectedRealmId ​

number

The ID of the connected realm.

Returns ​

The auction house index. See AuctionHouseIndexResponse.

_responseType? ​

optional _responseType?: AuctionHouseIndexResponse

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.