Used to access Steam leaderboards.

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

DeleteLeaderboard

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	appid of game
name	string	✔	name 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

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	appid of game
name	string	✔	name of the leaderboard to create
sortmethod	string		sort method to use for this leaderboard (defaults to Ascending)
displaytype	string		display type for this leaderboard (defaults to Numeric)
createifnotfound	bool		if this is true the leaderboard will be created if it doesn't exist. Defaults to true.
onlytrustedwrites	bool		if this is true the leaderboard scores cannot be set by clients, and can only be set by publisher via SetLeaderboardScore WebAPI. Defaults to false.
onlyfriendsreads	bool		if 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

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	appid of game
rangestart	int32	✔	range start or 0
rangeend	int32	✔	range end or max LB entries
steamid	uint64		SteamID used for friend & around user requests
leaderboardid	int32	✔	ID of the leaderboard to view
datarequest	string	✔	type 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

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	appid 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

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	appid of game
leaderboardid	uint32	✔	numeric 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

Name	Type	Required	Description
key	string	✔	Steamworks Web API publisher authentication key.
appid	uint32	✔	appid of game
leaderboardid	uint32	✔	numeric ID of the target leaderboard. Can be retrieved from GetLeaderboardsForGame
steamid	uint64	✔	steamID to set the score for
score	int32	✔	the score to set for this user
scoremethod	string	✔	update method to use. Can be "KeepBest" or "ForceUpdate"
details	rawbinary		game-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!