get_legacy_ladders {SC2API}R Documentation

Legacy API - Profile Ladder Summary

Description

Provides information about a profile's performance in the current season, previous season, and showcase entries.

Usage

get_legacy_ladders(region_id, realm_id, profile_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

realm_id

A numeric argument indicating the realm of the profile. A realm is a subset of the region.

  • US Region

    • 1 = US

    • 2 = LatAm

  • EU Region

    • 1 = Europe

    • 2 = Russia

  • KR/TW Region

    • 1 = Korea

    • 2 = Taiwan

profile_id

A unique, numeric identifier for an individual's profile.

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. For similar information, use get_ladder_summary.

References

See Also

get_ladder_summary

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


[Package SC2API version 1.0.0 Index]