IPlayerService – Steam Web API Documentation

This page is just a reference of all the known Steam APIs, I do not know how they work. Please do not email me with questions.

UNDOCUMENTEDPOSTAddFriend

Invites another Steam user to be a friend

https://api.steampowered.com/IPlayerService/AddFriend/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	Steam ID of user to whom to send a friend invite.

UNDOCUMENTEDClientGetLastPlayedTimes

Gets the last-played times for the account

https://api.steampowered.com/IPlayerService/ClientGetLastPlayedTimes/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
min_last_played		uint32	No	The most recent last-played time the client already knows about

UNDOCUMENTEDPOSTGetAchievementsProgress

Gets the achievement completion stats for the specified list of apps.

https://api.steampowered.com/IPlayerService/GetAchievementsProgress/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	No
language		string	No
appids[0]		uint32[]	No
include_unvetted_apps		bool	No

UNDOCUMENTEDGetAnimatedAvatar

Gets which animated avatar is active for a specific user

https://api.steampowered.com/IPlayerService/GetAnimatedAvatar/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	The player we're asking about
language		string	No

UNDOCUMENTEDGetAvatarFrame

Gets which avatar frame is active for a specific user

https://api.steampowered.com/IPlayerService/GetAvatarFrame/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	The player we're asking about
language		string	No

GETGetBadges

Gets badges that are owned by a specific user

https://api.steampowered.com/IPlayerService/GetBadges/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	The player we're asking about

GETGetCommunityBadgeProgress

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

https://api.steampowered.com/IPlayerService/GetCommunityBadgeProgress/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	The player we're asking about
badgeid		int32	Yes	The badge we're asking about

UNDOCUMENTEDPOSTGetCommunityPreferences

Returns the player's community preferences

https://api.steampowered.com/IPlayerService/GetCommunityPreferences/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTEDGetFavoriteBadge

Gets the badge the user has set as their favorite

https://api.steampowered.com/IPlayerService/GetFavoriteBadge/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	No

UNDOCUMENTEDGetFriendsGameplayInfo

Get a list of friends who are playing, have played, own, or want a game

https://api.steampowered.com/IPlayerService/GetFriendsGameplayInfo/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No

UNDOCUMENTEDGetGameAchievements

Get a games available achievements for display purposes.

https://api.steampowered.com/IPlayerService/GetGameAchievements/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No
language		string	No	Lowercase, language shortnames

UNDOCUMENTEDGetMiniProfileBackground

Gets which mini profile background is active for a specific user

https://api.steampowered.com/IPlayerService/GetMiniProfileBackground/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	The player we're asking about
language		string	No

UNDOCUMENTEDGetNicknameList

Gets the list of nicknames this user has for other users

https://api.steampowered.com/IPlayerService/GetNicknameList/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

GETGetOwnedGames

Return a list of games owned by the player

https://api.steampowered.com/IPlayerService/GetOwnedGames/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	The player we're asking about
include_appinfo		bool	Yes	true if we want additional details (name, icon) about each game
include_played_free_games		bool	Yes	Free games are excluded by default. If this is set, free games the user has played will be returned.
appids_filter		uint32	Yes	if set, restricts result set to the passed in apps
include_free_sub		bool	Yes	Some games are in the free sub, which are excluded by default.
skip_unvetted_apps		bool	No	if set, skip unvetted store apps
language		string	Yes	Will return appinfo in this language
include_extended_appinfo		bool	Yes	true if we want even more details (capsule, sortas, and capabilities) about each game. include_appinfo must also be true.

UNDOCUMENTEDGetPlayerLinkDetails

Replacement for WG GetPlayerLinkDetails

https://api.steampowered.com/IPlayerService/GetPlayerLinkDetails/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamids[0]		uint64[]	No

UNDOCUMENTEDGetProfileBackground

Gets which profile background is active for a specific user

https://api.steampowered.com/IPlayerService/GetProfileBackground/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	The player we're asking about
language		string	No

UNDOCUMENTEDGetProfileCustomization

Returns the customizations (if any) for a profile

https://api.steampowered.com/IPlayerService/GetProfileCustomization/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No
include_inactive_customizations		bool	No
include_purchased_customizations		bool	No

UNDOCUMENTEDGetProfileItemsEquipped

Returns the items the user has equipped on their profile

https://api.steampowered.com/IPlayerService/GetProfileItemsEquipped/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No
language		string	No

UNDOCUMENTEDGetProfileItemsOwned

Returns the items the user can equip on their profile

https://api.steampowered.com/IPlayerService/GetProfileItemsOwned/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
language		string	No
filters		ECommunityItemClass	No
filters[0]		int32[]	No	enum

UNDOCUMENTEDGetProfileThemesAvailable

Gets themes available for the user.

https://api.steampowered.com/IPlayerService/GetProfileThemesAvailable/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key

UNDOCUMENTEDGetPurchasedAndUpgradedProfileCustomizations

Returns the purchased and upgraded profile customizations

https://api.steampowered.com/IPlayerService/GetPurchasedAndUpgradedProfileCustomizations/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No

UNDOCUMENTEDGetPurchasedProfileCustomizations

Returns the purchased profile customizations

https://api.steampowered.com/IPlayerService/GetPurchasedProfileCustomizations/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No

UNDOCUMENTEDPOSTGetRecentPlaytimeSessionsForChild

https://api.steampowered.com/IPlayerService/GetRecentPlaytimeSessionsForChild/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	No

GETGetRecentlyPlayedGames

Gets information about a player's recently played games

https://api.steampowered.com/IPlayerService/GetRecentlyPlayedGames/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	The player we're asking about
count		uint32	Yes	The number of games to return (0/unset: all)

UNDOCUMENTEDGETGetSingleGamePlaytime

https://api.steampowered.com/IPlayerService/GetSingleGamePlaytime/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Steamworks Web API user authentication key.
steamid		uint64	Yes	The player we're asking about
appid		uint32	Yes	AppID that we're getting playtime for

UNDOCUMENTEDGetSteamDeckKeyboardSkin

Gets which Steam Deck keyboard skin is active for a specific user

https://api.steampowered.com/IPlayerService/GetSteamDeckKeyboardSkin/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	The player we're asking about
language		string	No

GETGetSteamLevel

Returns the Steam Level of a user

https://api.steampowered.com/IPlayerService/GetSteamLevel/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	The player we're asking about

UNDOCUMENTEDGetSteamLevelDistribution

Returns how a given Steam Level compares the user base at large

https://api.steampowered.com/IPlayerService/GetSteamLevelDistribution/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
player_level		uint32	Yes

UNDOCUMENTEDGetTopAchievementsForGames

Gets the best achievements the user has gotten for the specified list of apps.

https://api.steampowered.com/IPlayerService/GetTopAchievementsForGames/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	No
language		string	No
max_achievements		uint32	No	The max achievements to load. Max 8
appids[0]		uint32[]	No

UNDOCUMENTEDPOSTIgnoreFriend

Blocks or unblocks communication with the user. Despite name, can be a non-friend.

https://api.steampowered.com/IPlayerService/IgnoreFriend/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No
unignore		bool	No	If set, remove from ignore/block list instead of adding

GETIsPlayingSharedGame

Obsolete, partners should use ISteamUser.CheckAppOwnership

https://api.steampowered.com/IPlayerService/IsPlayingSharedGame/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	The player we're asking about
appid_playing		uint32	Yes	The game player is currently playing

POSTRecordOfflinePlaytime

Tracks playtime for a user when they are offline

https://api.steampowered.com/IPlayerService/RecordOfflinePlaytime/v1/

Name	Type	Required
steamid	uint64	Yes
ticket	string	Yes
play_sessions	{message}	Yes

UNDOCUMENTEDPOSTRemoveFriend

Removes a friend or ignores a friend suggestion

https://api.steampowered.com/IPlayerService/RemoveFriend/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		fixed64	No	Steam ID of friend to remove.

UNDOCUMENTEDPOSTSetAnimatedAvatar

Sets the user's animated avatar for their profile

https://api.steampowered.com/IPlayerService/SetAnimatedAvatar/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No

UNDOCUMENTEDPOSTSetAvatarFrame

Sets the user's avatar frame for their profile

https://api.steampowered.com/IPlayerService/SetAvatarFrame/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No

UNDOCUMENTEDPOSTSetEquippedProfileItemFlags

Sets special flags on the equipped item

https://api.steampowered.com/IPlayerService/SetEquippedProfileItemFlags/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No
flags		uint32	No	Set of EProfileItemEquippedFlag

UNDOCUMENTEDPOSTSetFavoriteBadge

Sets the badge as the users favorite

https://api.steampowered.com/IPlayerService/SetFavoriteBadge/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No
badgeid		uint32	No

UNDOCUMENTEDPOSTSetMiniProfileBackground

Sets the user's mini profile background

https://api.steampowered.com/IPlayerService/SetMiniProfileBackground/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No

UNDOCUMENTEDPOSTSetProfileBackground

Sets the user's profile background

https://api.steampowered.com/IPlayerService/SetProfileBackground/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No

UNDOCUMENTEDPOSTSetProfilePreferences

Sets profile preferences

https://api.steampowered.com/IPlayerService/SetProfilePreferences/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
profile_preferences		ProfilePreferences	No
↳ hide_profile_awards		bool	No

UNDOCUMENTEDPOSTSetProfileTheme

Selects a theme for the profile

https://api.steampowered.com/IPlayerService/SetProfileTheme/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
theme_id		string	No

UNDOCUMENTEDPOSTSetSteamDeckKeyboardSkin

Sets the user's current Steam Deck keyboard skin

https://api.steampowered.com/IPlayerService/SetSteamDeckKeyboardSkin/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
communityitemid		uint64	No