get_gm_leaderboard {SC2API}

Grandmaster Leaderboard

Description

Provides a full listing of players currently in the grandmaster leaderboard. Also provides other information such as player profile information, records (match record, MMR, etc.), and clans.

Usage

get_gm_leaderboard(region_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

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

This API call is currently not supported for the China region (region_id = 5).

References

• Blizzard Community API Documentation

• Regionality and APIs

• Grandmaster League

See Also

Other ladder data API calls: get_season()

Examples

# Obtain GM leaderboard for the Korea region
try(get_gm_leaderboard(region_id = 3))