Allows partners to globally search the content of their
Steam Workshop.
See the primary Steam Workshop interface
ISteamRemoteStorage for more.
For more info on how to use the Steamworks Web API please see the
Web API Overview.
RankedByPublicationOrder
POST https://partner.steam-api.com/ISteamPublishedItemSearch/RankedByPublicationOrder/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appID of product |
| startidx | uint32 | ✔ | Starting index in the result set (0 based) |
| count | uint32 | ✔ | Number Requested |
| tagcount | uint32 | ✔ | Number of Tags Specified |
| usertagcount | uint32 | ✔ | Number of User specific tags requested |
| hasappadminaccess | bool | | Whether the user making the request is an admin for the app and can see private files |
| fileType | uint32 | | EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items |
| tag[0] | string | | Tag to filter result set |
| usertag[0] | string | | A user specific tag |
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!
RankedByTrend
POST https://partner.steam-api.com/ISteamPublishedItemSearch/RankedByTrend/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appID of product |
| startidx | uint32 | ✔ | Starting index in the result set (0 based) |
| count | uint32 | ✔ | Number Requested |
| tagcount | uint32 | ✔ | Number of Tags Specified |
| usertagcount | uint32 | ✔ | Number of User specific tags requested |
| hasappadminaccess | bool | | Whether the user making the request is an admin for the app and can see private files |
| fileType | uint32 | | EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items |
| days | uint32 | | [1,7] number of days for the trend period, including today |
| tag[0] | string | | Tag to filter result set |
| usertag[0] | string | | A user specific tag |
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!
RankedByVote
POST https://partner.steam-api.com/ISteamPublishedItemSearch/RankedByVote/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint32 | ✔ | appID of product |
| startidx | uint32 | ✔ | Starting index in the result set (0 based) |
| count | uint32 | ✔ | Number Requested |
| tagcount | uint32 | ✔ | Number of Tags Specified |
| usertagcount | uint32 | ✔ | Number of User specific tags requested |
| hasappadminaccess | bool | | Whether the user making the request is an admin for the app and can see private files |
| fileType | uint32 | | EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items |
| tag[0] | string | | Tag to filter result set |
| usertag[0] | string | | A user specific tag |
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!
ResultSetSummary
POST https://partner.steam-api.com/ISteamPublishedItemSearch/ResultSetSummary/v1/
| Name | Type | Required | Description |
|---|
| key | string | ✔ | Steamworks Web API publisher authentication key. |
| steamid | uint64 | ✔ | SteamID of user |
| appid | uint64 | ✔ | appID relevant to all subsequent tags |
| tagcount | uint32 | ✔ | Number of Tags Specified |
| usertagcount | uint32 | ✔ | Number of User specific tags requested |
| hasappadminaccess | bool | | Whether the user making the request is an admin for the app and can see private files |
| fileType | uint32 | | EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items |
| tag[0] | string | | Tag to filter result set |
| usertag[0] | string | | A user specific tag |
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!
