Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamLeaderboards Interface
Used to access Steam leaderboards.

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

DeleteLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32appid of game
namestringname of the leaderboard to delete



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

FindOrCreateLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32appid of game
namestringname of the leaderboard to create
sortmethodstringsort method to use for this leaderboard (defaults to Ascending)
displaytypestringdisplay type for this leaderboard (defaults to Numeric)
createifnotfoundboolif this is true the leaderboard will be created if it doesn't exist. Defaults to true.
onlytrustedwritesboolif this is true the leaderboard scores cannot be set by clients, and can only be set by publisher via SetLeaderboardScore WebAPI. Defaults to false.
onlyfriendsreadsboolif this is true the leaderboard scores can only be read for friends by clients, scores can always be read by publisher. Defaults to false.



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 leaderboard name in XML.

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

GetLeaderboardEntries

GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32appid of game
rangestartint32range start or 0
rangeendint32range end or max LB entries
steamiduint64SteamID used for friend & around user requests
leaderboardidint32ID of the leaderboard to view
datarequestuint32type of request: RequestGlobal, RequestAroundUser, RequestFriends



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

GetLeaderboardsForGame

GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32appid of 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 leaderboard name in XML.

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

ResetLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32appid of game
leaderboardiduint32numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame



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

SetLeaderboardScore

POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
appiduint32appid of game
leaderboardiduint32numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
steamiduint64steamID to set the score for
scoreint32the score to set for this user
scoremethodstringupdate method to use. Can be "KeepBest" or "ForceUpdate"
detailsrawbinarygame-specific details for how the score was earned. Up to 256 bytes.



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