Unaffiliated

Home Documentation & Help
Steamworks Documentation
IPlayerService Interface
Provides additional methods for interacting with Steam Users.

See ISteamUser for the primary interface.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

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

RecordOfflinePlaytime

POST https://api.steampowered.com/IPlayerService/RecordOfflinePlaytime/v1/
NameTypeRequiredDescription
steamiduint64The player we're asking about
ticketstringThe users authentication ticket.
play_sessions{message}The recorded play sessions.

Tracks playtime for a user when they are offline

GetRecentlyPlayedGames

GET https://api.steampowered.com/IPlayerService/GetRecentlyPlayedGames/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we're asking about
countuint32The number of games to return (0/unset: all)

Gets information about a player's recently played games

GetOwnedGames

GET https://api.steampowered.com/IPlayerService/GetOwnedGames/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we're asking about
include_appinfobooltrue if we want additional details (name, icon) about each game
include_played_free_gamesboolFree games are excluded by default. If this is set, free games the user has played will be returned.
appids_filteruint32if set, restricts result set to the passed in apps

Return a list of games owned by the player

GetSteamLevel

GET https://api.steampowered.com/IPlayerService/GetSteamLevel/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we're asking about

Returns the Steam Level of a user

GetBadges

GET https://api.steampowered.com/IPlayerService/GetBadges/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we're asking about

Gets badges that are owned by a specific user

GetCommunityBadgeProgress

GET https://api.steampowered.com/IPlayerService/GetCommunityBadgeProgress/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we're asking about
badgeidint32The badge we're asking about

Gets all the quests needed to get the specified badge, and which are completed

IsPlayingSharedGame

GET https://api.steampowered.com/IPlayerService/IsPlayingSharedGame/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we're asking about
appid_playinguint32The game player is currently playing

Returns valid lender SteamID if game currently played is borrowed