Skip to content

Documentation


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

Function: pvpLeaderboardIndex() ​

pvpLeaderboardIndex(namespace, pvpRegionId, pvpSeasonId): object

Defined in: classic-wow/src/pvp-season/index.ts:91

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

Parameters ​

namespace ​

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

The namespace to use. See DynamicClassicNamespaces.

pvpRegionId ​

number

The PvP region ID.

pvpSeasonId ​

number

The PvP season ID.

Returns ​

The PvP leaderboard index.

_responseType? ​

optional _responseType?: unknown

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.