get_league_data: League Data

In SC2API: Blizzard SC2 API Wrapper

Description

League data is divided into 3 tiers for each league (with the exception of grandmaster, which only has 1 tier) and further divided into a number of divisions depending on how many players are in a given league. League data contains the number of divisions, the unique ladder ID of each division and the total player count contained within each division.

Usage

get_league_data(season_id, queue_id, team_type, league_id, host_region = "us")

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.

Note

League data is only available for season 28 and higher.

References

• Blizzard Community API Documentation

• Regionality and APIs

See Also

Other game data API calls: get_ladder_data(), get_season_data()

Examples

# Get full league data for Season 30, LotV 1v1, arranged teams,
# Masters league, U.S. region.
try({
    data <- get_league_data(season_id = 30,
                            queue_id = 201,
                            team_type = 0,
                            league_id = 5,
                            host_region = "us")
})

SC2API documentation built on Oct. 23, 2020, 7:10 p.m.