Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamPublishedItemSearch Interface
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/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appiduint32appID of product
startidxuint32Starting index in the result set (0 based)
countuint32Number Requested
tagcountuint32Number of Tags Specified
usertagcountuint32Number of User specific tags requested
hasappadminaccessboolWhether the user making the request is an admin for the app and can see private files
fileTypeuint32EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
tag[0]stringTag to filter result set
usertag[0]stringA 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/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appiduint32appID of product
startidxuint32Starting index in the result set (0 based)
countuint32Number Requested
tagcountuint32Number of Tags Specified
usertagcountuint32Number of User specific tags requested
hasappadminaccessboolWhether the user making the request is an admin for the app and can see private files
fileTypeuint32EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
daysuint32[1,7] number of days for the trend period, including today
tag[0]stringTag to filter result set
usertag[0]stringA 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/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appiduint32appID of product
startidxuint32Starting index in the result set (0 based)
countuint32Number Requested
tagcountuint32Number of Tags Specified
usertagcountuint32Number of User specific tags requested
hasappadminaccessboolWhether the user making the request is an admin for the app and can see private files
fileTypeuint32EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
tag[0]stringTag to filter result set
usertag[0]stringA 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/
NameTypeRequiredDescription
keystringSteamworks Web API publisher authentication key.
steamiduint64SteamID of user
appiduint64appID relevant to all subsequent tags
tagcountuint32Number of Tags Specified
usertagcountuint32Number of User specific tags requested
hasappadminaccessboolWhether the user making the request is an admin for the app and can see private files
fileTypeuint32EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items
tag[0]stringTag to filter result set
usertag[0]stringA 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!