StarCraft II

StarCraft II game data and community endpoints, including the legacy ones.

15 endpoints on client.sc2. Response types are documented on JSR: Sc2Api.

Game data#

leagueData(seasonId: number, queueId: number, teamType: number, leagueId: number): League
Returns data for the specified season, queue, team, and league.

player(accountId: number): Sc2Player[]
Returns the StarCraft II players linked to an account.

grandmasterLeaderboard(regionId: number): Sc2GrandmasterLeaderboard
Returns the grandmaster leaderboard for a region.
season(regionId: number): Sc2Season
Returns the current season for a region.

legacyAchievements(regionId: number): Sc2LegacyAchievements
Returns the legacy StarCraft II achievements for a region.
legacyLadder(regionId: number, ladderId: string): Sc2LegacyLadder
Returns a legacy StarCraft II ladder.
legacyLadders(regionId: number, realmId: number, profileId: number): Sc2LegacyLadders
Returns the legacy StarCraft II ladders of a player.
legacyMatches(regionId: number, realmId: number, profileId: number): Sc2LegacyMatches
Returns the legacy StarCraft II matches of a player.
legacyProfile(regionId: number, realmId: number, profileId: number): Sc2LegacyProfile
Returns the legacy StarCraft II profile of a player.
legacyRewards(regionId: number): Sc2LegacyRewards
Returns the legacy StarCraft II rewards for a region.

ladder(regionId: number, realmId: number, profileId: number, ladderId: string): Sc2Ladder
Returns a StarCraft II ladder.
ladderSummary(regionId: number, realmId: number, profileId: number): Sc2LadderSummary
Returns the ladder summary of a StarCraft II profile.
metadataProfile(regionId: number, realmId: number, profileId: number): Sc2ProfileMetadata
Returns the metadata of a StarCraft II profile.
profile(regionId: number, realmId: number, profileId: number): Sc2PlayerProfile
Returns a StarCraft II profile.
staticProfile(regionId: number): Sc2StaticProfile
Returns the static StarCraft II profile data (achievements, criteria, categories and rewards) for a region.