module SteamApi::ISteamUserStats

This module is for interacting with the ISteamUserStats interface of the Steam Web API. More information about this interface can be found at wiki.teamfortress.com/wiki/WebAPI

Public Instance Methods

get_global_achievement_percentages_for_app(gameid) click to toggle source

Gets information about achievement percentages for a certain app. @param gameid [String] A specific Steam app id @return [Hash] Contains a hash with information about percentage completion More information can be found at wiki.teamfortress.com/wiki/WebAPI/GetGlobalAchievementPercentagesForApp

# File lib/steam_api/i_steam_user_stats.rb, line 9
def get_global_achievement_percentages_for_app(gameid)
  url = SteamApi::Urls.global_achievement_percentages_for_app(gameid)
  response = get(url, key_needed: false)
end
get_number_of_current_players(gameid) click to toggle source

Gets information about number of current players for a certain app. @param gameid [String] A specific Steam app id @return [Hash] Contains a hash with information about number of current players More information can be found at wiki.teamfortress.com/wiki/WebAPI/GetNumberOfCurrentPlayers

# File lib/steam_api/i_steam_user_stats.rb, line 18
def get_number_of_current_players(gameid)
  url = SteamApi::Urls.number_of_current_players(gameid)
  response = get(url, key_needed: false)
end
get_player_achievements(userid, gameid) click to toggle source

Gets information about a players achievements for a specific app. @param userid [String] A specific user's steam id 64 @param gameid [String] A specific game's steam id 64 @return [Hash] Contains a hash with information about the achievement completion if the user and game exist. The user must also be public More information can be found at wiki.teamfortress.com/wiki/WebAPI/GetPlayerAchievements

# File lib/steam_api/i_steam_user_stats.rb, line 28
def get_player_achievements(userid, gameid)
  url = SteamApi::Urls.player_achievements(userid, gameid)
  response = get(url, key_needed: true)
end
get_schema_for_game(gameid) click to toggle source

Gets information about the schema for a game for a specific id. @param gameid [String] A specific game's steam id 64 @return [Hash] Contains a hash with information about the schema for a game. (if the game was found) More information can be found at wiki.teamfortress.com/wiki/WebAPI/GetSchemaForGame

# File lib/steam_api/i_steam_user_stats.rb, line 37
def get_schema_for_game(gameid)
  url = SteamApi::Urls.schema_for_game(gameid)
  response = get(url, key_needed: true)
end
get_user_stats_for_game(userid, gameid) click to toggle source

Gets information about the users stats for a certain game @param userid [String] A specific user's steam id 64 @param gameid [String] A specific game's steam id 64 @return [Hash] Contains a hash with information about the users stats for a game (if the game was found and profile is public) More information can be found at wiki.teamfortress.com/wiki/WebAPI/GetUserStatsForGame

# File lib/steam_api/i_steam_user_stats.rb, line 47
def get_user_stats_for_game(userid, gameid)
  url = SteamApi::Urls.user_stats_for_game(userid, gameid)
  response = get(url, key_needed: true)
end