get_ladder {SC2API}

Ladder Details and Profile Rank

Description

Provides information about a particular ladder and the individual's rank and status within that ladder (i.e. rank, MMR, etc.).

Usage

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

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.

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.

References

• Blizzard Community API Documentation

• Regionality and APIs

See Also

Other profile API calls: get_ladder_summary(), get_metadata(), get_profile(), get_static()

Examples

# Obtaining the overall ladder performance of a profile.
try({
    ladderData <- get_ladder_summary(region_id = 1, realm_id = 1, profile_id = 4716773)

    # Choose a single ladder ID
    ladderID <- ladderData$allLadderMemberships$ladderId[1]

    # Get full ladder information and the profile's performance in this ladder
    get_ladder(region_id = 1, realm_id = 1, profile_id = 4716773, ladder_id = ladderID)
})