Primary interface for interacting with the
Steam Workshop and User Generated Content (UGC).
See
IPublishedFileService,
IWorkshopService,
ISteamPublishedItemSearch, and
ISteamPublishedItemVoting for additional Workshop and UGC related methods.
EnumerateUserSubscribedFiles
POST https://partner.steam-api.com/ISteamRemoteStorage/EnumerateUserSubscribedFiles/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appID of product |
| listtype | uint32 | | EUCMListType |
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!
GetCollectionDetails
POST https://api.steampowered.com/ISteamRemoteStorage/GetCollectionDetails/v1/
| Name | Type | Required | Description |
|---|
| collectioncount | uint32 | ✔ | Number of collections being requested |
| publishedfileids[0] | uint64 | ✔ | collection ids to get the details for |
GetPublishedFileDetails
POST https://api.steampowered.com/ISteamRemoteStorage/GetPublishedFileDetails/v1/
| Name | Type | Required | Description |
|---|
| itemcount | uint32 | ✔ | Number of items being requested |
| publishedfileids[0] | uint64 | ✔ | published file id to look up |
GetUGCFileDetails
GET https://api.steampowered.com/ISteamRemoteStorage/GetUGCFileDetails/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API user authentication key. |
| steamid | uint64 | | If specified, only returns details if the file is owned by the SteamID specified |
| ugcid | uint64 | ✔ | ID of UGC file to get info for |
| appid | uint32 | ✔ | appID of product |
SetUGCUsedByGC
POST https://partner.steam-api.com/ISteamRemoteStorage/SetUGCUsedByGC/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| ugcid | uint64 | ✔ | ID of UGC file whose bits are being fiddled with |
| appid | uint32 | ✔ | appID of product to change updating state for |
| used | bool | ✔ | New state of flag |
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!
SubscribePublishedFile
POST https://partner.steam-api.com/ISteamRemoteStorage/SubscribePublishedFile/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appID of product |
| publishedfileid | uint64 | ✔ | published file id to subscribe to |
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!
UnsubscribePublishedFile
POST https://partner.steam-api.com/ISteamRemoteStorage/UnsubscribePublishedFile/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appID of product |
| publishedfileid | uint64 | ✔ | published file id to unsubscribe from |
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!
|