Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamUserStats Interface
Used to access information about users.

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

GetGlobalAchievementPercentagesForApp

GET https://api.steampowered.com/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2/
NameTypeRequiredDescription
gameiduint64GameID to retrieve the achievement percentages for

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

GetGlobalStatsForGame

GET https://api.steampowered.com/ISteamUserStats/GetGlobalStatsForGame/v1/
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)

Retrieves the global achievement percentages for the specified app.

See the Global Stats documentation for more information.

GetNumberOfCurrentPlayers

GET https://api.steampowered.com/ISteamUserStats/GetNumberOfCurrentPlayers/v1/
NameTypeRequiredDescription
appiduint32AppID that we're getting user count for

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.

GetPlayerAchievements

GET https://api.steampowered.com/ISteamUserStats/GetPlayerAchievements/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
appiduint32AppID to get achievements for
lstringLanguage to return strings for

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

GetSchemaForGame

GET https://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v2/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
appiduint32appid of game
lstringlocalized language to return (english, french, etc.)

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.

GetUserStatsForGame

GET https://api.steampowered.com/ISteamUserStats/GetUserStatsForGame/v2/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
appiduint32appid of game

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.

SetUserStatsForGame

POST https://partner.steam-api.com/ISteamUserStats/SetUserStatsForGame/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appiduint32appid of game
countuint32Number of stats and achievements to set a value for (name/value param pairs)
name[0]stringName of stat or achievement to set
value[0]uint32Value to set

Sets a stat for the specified user for the game.

NOTE: This call requires the publisher API key that owns the specified App ID to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!