SC2API (version 1.0.0)

get_ladder_ids: League Ladder ID's

Description

Provides ladder ID's for all divisions in a league's tiers.

Usage

get_ladder_ids(season_id, queue_id, team_type, league_id, host_region)

Arguments

season_id

A numeric argument indicating a particular ladder season. Currently, league data is only available for season 28 and higher (i.e. data prior to this season is inaccessible).

queue_id

• 1 = WoL 1v1

• 2 = WoL 2v2

• 3 = WoL 3v3

• 4 = WoL 4V4

• 101 = HotS 1v1

• 102 = HotS 2v2

• 103 = HotS 3v3

• 104 = HotS 4v4

• 201 = LotV 1v1

• 202 = LotV 2v2

• 203 = LotV 3v3

• 204 = LotV 4v4

• 206 = LotV Archon

team_type

• 0 = Arranged

• 1 = Random

league_id

• 0 = Bronze

• 1 = Silver

• 2 = Gold

• 3 = Platinum

• 4 = Diamond

• 5 = Masters

• 6 = Grandmaster

host_region

The host region that the API call will be sent to. For get_league_data, the host region affects the data you will receive (i.e. different regions will result in different data). Must be one of "us", "eu", "kr", "tw", "cn". For more information on regionality, refer to Regionality and APIs.

Value

List of ladder ID's separated by tier. For grandmaster league, an integer is returned.

References

• Blizzard Community API Documentation

• Regionality and APIs

Examples

# NOT RUN {
# Get all ladder ID's for Season 35, LotV 2v2, randomly gathered teams,
# Bronze league, Korean region.
try({
    data <- get_ladder_ids(season_id = 35,
                           queue_id = 202,
                           team_type = 1,
                           league_id = 0,
                           host_region = "kr")
})
# }