Skip to content

Documentation


Documentation / @blizzard-api/sc2 / grandmasterLeaderboard

Function: grandmasterLeaderboard() ​

grandmasterLeaderboard(regionId): object

Defined in: sc2/src/ladder/index.ts:11

Returns the grandmaster leaderboard for the specified region.

Parameters ​

regionId ​

StarcraftRegion

The region ID

Returns ​

The grandmaster leaderboard resource. See GrandmasterLeaderboardResponse.

_responseType? ​

optional _responseType?: GrandmasterLeaderboardResponse

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.