Achievements — get_game_achievements • steamr

Retrieve game achievements, either globally or for a specific user.

get_game_achievements(appid, language = "english")

get_top_achievements(
  steamid,
  appids,
  max_achievements = 5L,
  language = "english"
)

get_player_achievements(steamid, appid, language = "english")

Arguments

appid

appID of an application in the Steam store.

steamid

SteamID of a user. The SteamID must be in a format that can be converted by convert_steamid. This includes vanity, Steam64, Steam2, and Steam3 IDs.

appids

A vector of multiple appIDs of applications in the Steam store. There are generally two ways of retrieving an appID:

Inspect or parse the store URL of an application, e.g. https://store.steampowered.com/app/10/CounterStrike/
Query applications programmatically, e.g. using search_apps

max_achievements

Maximum number of achievements to return for each game. Defaults to the top 5 achievements.

Value

get_game_achievements

A dataframe containing information about the achievements unlockable in a game. internal_name provides a machine-readable name for each achievement. localized_name and localized_desc provide human-readable and localized variants of achievement name and description. Both icon and icon_gray are files that can be accessed by appending it to the following URL:

https://cdn.akamai.steamstatic.com/steamcommunity/public/images/apps/{appid}/

hidden reports on whether an achievement is hidden to the player. player_percentage_unlocked is a global statistic on how many total players have unlocked the achievement.

get_top_achievements

A dataframe in long format containing the top max_achievements game achievements for a player and for each game in appids. The output columns largely correspond to the output of get_game_achievements.

get_player_achievements

A dataframe containing all achievements of a user in a game. apiname, name, and description correspond to machine-readable and human-readable achievement names. achieved reports whether an achievement has been unlocked by the user. unlocktime reports on the time of doing so. If access to the user achievements is denied, an empty dataframe is returned.

Details

get_top_achievements and get_player_achievements require access to the user's game achievements. get_top_achievements returns an error code 15: AccessDenied, while get_player_achievements simply returns an empty dataframe.