get_season {SC2API}R Documentation

Current Season Information

Description

Provides the current season ID, starting date, and ending date.

Usage

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

References

See Also

Other ladder data API calls: get_gm_leaderboard()

Examples


# Obtain current season information for the European region
try(get_season(region_id = 2))


[Package SC2API version 1.0.0 Index]