SteamEx v0.2.0-alpha SteamEx.ISteamUserStats View Source

Used to access information about users.

For more info on how to use the Steamworks Web API please see the Web API Overview.

Link to this section Summary

Functions

Retrieves the global achievement percentages for the specified app

Retrieves the global achievement percentages for the specified app

Gets the total number of players currently active in the specified app on Steam

Gets the list of achievements the specified user has unlocked in an app

Gets the complete list of stats and achievements for the specified game

Gets the list of stats that the specified user has set in an app

Link to this section Functions

Link to this function get_global_achievement_percentages_for_app(access_key, params \\ %{}, headers \\ %{}) View Source

Retrieves the global achievement percentages for the specified app.

This method has previous versions which are no longer officially supported. They will continue to be usable but it’s highly recommended that you use the latest version. Change history:

  • Version 2 - Removes element names from arrays
NameTypeRequiredDescription
gameiduint64GameID to retrieve the achievement percentages for

See other: https://partner.steamgames.com/doc/webapi/ISteamUserStats#GetGlobalAchievementPercentagesForApp

Link to this function get_global_stats_for_game(access_key, params \\ %{}, headers \\ %{}) View Source

Retrieves the global achievement percentages for the specified app.

See the Global Stats documentation for more information.

NameTypeRequiredDescription
appiduint32AppID that we’re getting global stats for
countuint32Number of stats get data for
name[0]stringNames of stat to get data for
startdateuint32Start date for daily totals (unix epoch timestamp)
enddateuint32End date for daily totals (unix epoch timestamp)

See other: https://partner.steamgames.com/doc/webapi/ISteamUserStats#GetGlobalStatsForGame

Link to this function get_number_of_current_players(access_key, params \\ %{}, headers \\ %{}) View Source

Gets the total number of players currently active in the specified app on Steam.

Note that this will not return players that are playing while not connected to Steam.

NameTypeRequiredDescription
appiduint32AppID that we’re getting user count for

See other: https://partner.steamgames.com/doc/webapi/ISteamUserStats#GetNumberOfCurrentPlayers

Link to this function get_player_achievements(access_key, params \\ %{}, headers \\ %{}) View Source

Gets the list of achievements the specified user has unlocked in an app.

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
appiduint32AppID to get achievements for
lstringLanguage to return strings for

See other: https://partner.steamgames.com/doc/webapi/ISteamUserStats#GetPlayerAchievements

Link to this function get_schema_for_game(access_key, params \\ %{}, headers \\ %{}) View Source

Gets the complete list of stats and achievements for the specified game.

This method has previous versions which are no longer officially supported. They will continue to be usable but it’s highly recommended that you use the latest version. Change history:

  • Version 2 - Fixes returning the game name in XML.
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
appiduint32appid of game
lstringlocalized language to return (english, french, etc.)

See other: https://partner.steamgames.com/doc/webapi/ISteamUserStats#GetSchemaForGame

Link to this function get_user_stats_for_game(access_key, params \\ %{}, headers \\ %{}) View Source

Gets the list of stats that the specified user has set in an app.

This method has previous versions which are no longer officially supported. They will continue to be usable but it’s highly recommended that you use the latest version. Change history:

  • Version 2 - Fixes returning the game name in XML.
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
appiduint32appid of game

See other: https://partner.steamgames.com/doc/webapi/ISteamUserStats#GetUserStatsForGame