Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamUser Interface
Used to access information and interact with users.

See IPlayerService for additional methods.

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

CheckAppOwnership

GET https://partner.steam-api.com/ISteamUser/CheckAppOwnership/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appiduint32AppID to check for ownership

Checks if the specified user owns the app.

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!

GetAppPriceInfo

GET https://partner.steam-api.com/ISteamUser/GetAppPriceInfo/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appidsstringComma-delimited list of appids (max: 100)



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!

GetFriendList

GET https://api.steampowered.com/ISteamUser/GetFriendList/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
relationshipstringrelationship type (ex: friend)

GetPlayerBans

GET https://api.steampowered.com/ISteamUser/GetPlayerBans/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamidsstringComma-delimited list of SteamIDs

GetPlayerSummaries

GET https://api.steampowered.com/ISteamUser/GetPlayerSummaries/v2/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamidsstringComma-delimited list of SteamIDs (max: 100)



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

GetPublisherAppOwnership

GET https://partner.steam-api.com/ISteamUser/GetPublisherAppOwnership/v2/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user



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

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!

GetPublisherAppOwnershipChanges

GET https://partner.steam-api.com/ISteamUser/GetPublisherAppOwnershipChanges/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
packagerowversionstringThe unsigned 64-bit row version to read package changes from. The row version of data read up to will be returned for use in future calls.
cdkeyrowversionstringThe unsigned 64-bit row version to read CD Key changes from. The row version of data read up to will be returned for use in future calls.

This method can be used to determine what SteamIDs have ownership changes starting from a particular package or key row version number. From the list of SteamIDs returned, a call to GetPublisherAppOwnership can then return the associated ownership data for the applications in the group associated with the key passed in. A partner may wish to track this data in conjunction with linked Steam Accounts to better understand the state of product ownership on Steam.

To begin, make a call to GetPublisherAppOwnershipChanges passing in packagerowversion and cdkeyrowversion with the values of 0 (zero). The response from the call will look something like this:

"ownershipchanges": { "steamids": [ { "steamid": "76561198114498811" }, { "steamid": "76561198114498812" }, ... ], "packagerowversion": "12448390228", "cdkeyrowversion": "49857241147", "moredata": true }

The JSON response will contain the following fields:

NameTypeDescription
steamids/steamidstringThe list of SteamIDs for any accounts that have changed since the provided row versions. Up to 10,000 SteamIDs will be returned per call.
packagerowversionstringThe package row version that matches the last SteamID returned. Store this for future calls to GetPublisherAppOwnershipChanges
cdkeyrowversionstringThe cd key row version that matches the last SteamID returned. Store this for future calls to GetPublisherAppOwnershipChanges
moredataboolIndicates if more and newer data is available.

After this first call returns:
  1. Make a call to GetPublisherAppOwnership for each SteamID to get the actual ownership per AppID. Store or use that data as needed.
  2. Once all the SteamIDs have been processed, check the value of moredata. If it is true, make a new call to GetPublisherAppOwnershipChanges passing in the packagerowversion and cdkeyrowversion as returned from the previous call to GetPublisherAppOwnershipChanges.
  3. Repeat Step 1 and 2 until moredata returns false.
  4. Store the final packagerowversion and cdkeyrowversion values for use in future GetPublisherAppOwnershipChanges calls (e.g. 24 hours later) instead of starting at 0 (zero) again.

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!

GetUserGroupList

GET https://api.steampowered.com/ISteamUser/GetUserGroupList/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user

GrantPackage

POST https://partner.steam-api.com/ISteamUser/GrantPackage/v1/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
packageiduint32PackageID to grant
ipaddressstringip address of user in string format (xxx.xxx.xxx.xxx).
thirdpartykeystringOptionally associate third party key during grant. 'thirdpartyappid' will have to be set.
thirdpartyappiduint32Has to be set if 'thirdpartykey' is set. The appid associated with the 'thirdpartykey'.


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!

ResolveVanityURL

GET https://api.steampowered.com/ISteamUser/ResolveVanityURL/v1/
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
vanityurlstringThe vanity URL to get a SteamID for
url_typeint32The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group