get_legacy_ladder {SC2API}R Documentation

Legacy API - Ladder Details

Description

Provides a listing of players in a given ladder. Also provides other information such as their ladder record, points, profile information, and clan.

Usage

get_legacy_ladder(region_id, ladder_id, host_region = "us")

Arguments

region_id

A numeric argument indicating the region of the profile.

  • 1 = US Region

  • 2 = EU Region

  • 3 = KR/TW Region

  • 5 = CN Region

ladder_id

A unique identifier for a particular ladder. With the exception of Grandmaster, leagues (bronze, silver, etc.), are separated into tiers (1,2,3) which are further separated into divisions. These divisions, or ladders, each have a unique identifier.

host_region

The host region that the API call will be sent to. For most API calls, the same data will be returned regardless of which region the request is sent to. Must be one of "us", "eu", "kr", "tw", "cn". For more information on regionality, refer to Regionality and APIs.

Note

Legacy API call. It is recommended to use get_ladder_data instead.

References

See Also

get_ladder_data

Other legacy API calls: get_legacy_achievements(), get_legacy_ladders(), get_legacy_match_history(), get_legacy_profile(), get_legacy_rewards()


[Package SC2API version 1.0.0 Index]