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://partner.steam-api.com/ISteamUserStats/GetGlobalAchievementPercentagesForApp/v2/
| Name | Type | Required | Description |
|---|
| gameid | uint64 | ✔ | GameID 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://partner.steam-api.com/ISteamUserStats/GetGlobalStatsForGame/v1/
| Name | Type | Required | Description |
|---|
| appid | uint32 | ✔ | AppID that we're getting global stats for |
| count | uint32 | ✔ | Number of stats get data for |
| name[0] | string | ✔ | Names of stat to get data for |
| startdate | uint32 | | Start date for daily totals (unix epoch timestamp) |
| enddate | uint32 | | End date for daily totals (unix epoch timestamp) |
Retrieves the global stats percentages for the specified app.
See the
Global Stats documentation for more information.
GetNumberOfCurrentPlayers
GET https://partner.steam-api.com/ISteamUserStats/GetNumberOfCurrentPlayers/v1/
| Name | Type | Required | Description |
|---|
| appid | uint32 | ✔ | AppID 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://partner.steam-api.com/ISteamUserStats/GetPlayerAchievements/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API user authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | AppID to get achievements for |
| l | string | | Language to return strings for |
Gets the list of achievements the specified user has unlocked in an app.
GetSchemaForGame
GET https://partner.steam-api.com/ISteamUserStats/GetSchemaForGame/v2/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API user authentication key. |
| appid | uint32 | ✔ | appid of game |
| l | string | | localized 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://partner.steam-api.com/ISteamUserStats/GetUserStatsForGame/v2/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API user authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appid 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/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appid of game |
| count | uint32 | ✔ | Number of stats and achievements to set a value for (name/value param pairs) |
| name[0] | string | ✔ | Name of stat or achievement to set |
| value[0] | uint32 | ✔ | Value 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!
