Skip to content

Documentation


Documentation / @blizzard-api/sc2 / legacyLadder

Function: legacyLadder() ​

legacyLadder(regionId, ladderId): object

Defined in: sc2/src/legacy/index.ts:29

Returns the ladder information for the specified ladder.

Parameters ​

regionId ​

StarcraftRegion

The region ID for Starcraft.

ladderId ​

number

The ID of the ladder.

Returns ​

A resource representing the ladder. See LadderResponse

_responseType? ​

optional _responseType?: LegacyLaddersResponse

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.