Skip to content

Documentation


Documentation / @blizzard-api/d3 / seasonLeaderboard

Function: seasonLeaderboard() ​

seasonLeaderboard(id, leaderboard): object

Defined in: d3/src/game-data/index.ts:72

Returns the season leaderboard for the specified season ID and leaderboard.

Parameters ​

id ​

number

The ID of the season.

leaderboard ​

string

The name of the leaderboard.

Returns ​

The season leaderboard resource. See SeasonLeaderboardResponse.

_responseType? ​

optional _responseType?: SeasonLeaderboardResponse

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.