get_profile {SC2API}

Profile Data

Description

Provides summary data for an individual's profile such as campaign completion, career ladder finishes, earned achievements, and more.

Usage

get_profile(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.

References

• Blizzard Community API Documentation

• Regionality and APIs

See Also

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

Examples

# Request profile summary of a particular profile in the U.S. region and U.S. realm.
try(get_profile(region_id = 1, realm_id = 1, profile_id = 4716773))