Skip to content

Documentation


Documentation / @blizzard-api/sc2 / ladder

Function: ladder() ​

ladder(regionId, realmId, profileId, ladderId): object

Defined in: sc2/src/profile/index.ts:20

Returns the ladder information for the specified profile and ladder.

Parameters ​

regionId ​

StarcraftRegion

The region ID for Starcraft.

realmId ​

1 | 2

1 or 2

profileId ​

number

The ID of the profile.

ladderId ​

number

The ID of the ladder.

Returns ​

A resource representing the ladder. See LadderResponse

_responseType? ​

optional _responseType?: LadderResponse

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.