Skip to content

Documentation


Documentation / @blizzard-api/sc2 / getLeagueData

Function: getLeagueData() ​

getLeagueData(seasonId, queueId, teamType, leagueId): object

Defined in: sc2/src/league/index.ts:43

Returns the league data for the specified season, queue, team type, and league.

Parameters ​

seasonId ​

string

The season ID

queueId ​

StarcraftLeagueQueue

The queue ID

teamType ​

StarcraftLeagueTeamType

The team type

leagueId ​

StarcraftLeagueId

The league ID

Returns ​

The league data resource. See LeagueDataResponse.

_responseType? ​

optional _responseType?: LeagueDataResponse

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.