IPublishedFileService – 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.

UNDOCUMENTEDCanSubscribe

Check if the user can subscribe to the published file

https://api.steampowered.com/IPublishedFileService/CanSubscribe/v1/

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

PUBLISHERPOSTDelete

Deletes a published file.

https://partner.steam-api.com/IPublishedFileService/Delete/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes	Published file id of the file we'd like to delete.
appid		uint32	Yes

GETGetDetails

Retrieves information about a set of published files.

https://api.steampowered.com/IPublishedFileService/GetDetails/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileids[0]		uint64[]	Yes	Set of published file Ids to retrieve details for.
includetags		bool	Yes	If true, return tag information in the returned details.
includeadditionalpreviews		bool	Yes	If true, return preview information in the returned details.
includechildren		bool	Yes	If true, return children in the returned details.
includekvtags		bool	Yes	If true, return key value tags in the returned details.
includevotes		bool	Yes	If true, return vote data in the returned details.
short_description		bool	Yes	If true, return a short description instead of the full description.
includeforsaledata		bool	Yes	If true, return pricing data, if applicable.
includemetadata		bool	Yes	If true, populate the metadata field.
language		ELanguage	No	Specifies the localized text to return. Defaults to English.
return_playtime_stats		uint32	Yes	Return playtime stats for the specified number of days before today.
appid		uint32	Yes
strip_description_bbcode		bool	Yes	Strips BBCode from descriptions.
desired_revision		EPublishedFileRevision	No	Return the data for the specified revision.
includereactions		bool	No	If true, then reactions to items will be returned.
admin_query		bool	Yes	Admin tool is doing a query, return hidden items

GETGetSubSectionData

Get sub section data (for table of contents, a specific section, or all)

https://api.steampowered.com/IPublishedFileService/GetSubSectionData/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
for_table_of_contents		bool	Yes
specific_sectionid		uint64	Yes
desired_revision		{enum}	No	Return the data for the specified revision.

GETGetUserFileCount

Retrieves a count of files published by a user. Uses the same messages as GetUserFiles but totalonly must be true.

https://api.steampowered.com/IPublishedFileService/GetUserFileCount/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	Steam ID of the user whose files are being requested.
appid		uint32	Yes	App Id of the app that the files were published to.
shortcutid		uint32	No	Shortcut Id to retrieve published files from.
page		uint32	No	Starting page for results.
numperpage		uint32	No	The number of results, per page to return.
type		string	No	Type of files to be returned.
sortmethod		string	No	Sorting method to use on returned values.
privacy		uint32	No	Filter by privacy settings.
requiredtags		string	No	Tags that must be present on a published file to satisfy the query.
excludedtags		string	No	Tags that must NOT be present on a published file to satisfy the query.
required_kv_tags		{message}	Yes	Required key-value tags to match on.
filetype		uint32	No	File type to match files to.
creator_appid		uint32	Yes	App Id of the app that published the files, only matched if specified.
match_cloud_filename		string	Yes	Match this cloud filename if specified.
cache_max_age_seconds		uint32	No	Allow stale data to be returned for the specified number of seconds.
language		int32	No	Specifies the localized text to return. Defaults to English.
taggroups		{message}	No	At least one of the tags must be present on a published file to satisfy the query.
excluded_content_descriptors		{enum}	No	Filter out items that have these content descriptors.
admin_query		bool	Yes	Admin tool is doing a query, return hidden items
totalonly		bool	No	If true, only return the total number of files that satisfy this query.
ids_only		bool	No	If true, only return the published file ids of files that satisfy this query.
return_vote_data		bool	No	Return vote data
return_tags		bool	Yes	Return tags in the file details
return_kv_tags		bool	No	Return key-value tags in the file details
return_previews		bool	Yes	Return preview image and video details in the file details
return_children		bool	Yes	Return child item ids in the file details
return_short_description		bool	No	Populate the short_description field instead of file_description
return_for_sale_data		bool	Yes	Return pricing information, if applicable
return_metadata		bool	No	Populate the metadata field
return_playtime_stats		uint32	Yes	Return playtime stats for the specified number of days before today.
strip_description_bbcode		bool	Yes	Strips BBCode from descriptions.
return_reactions		bool	No	If true, then reactions to items will be returned.
startindex_override		uint32	Yes	Backwards compatible for the client.
desired_revision		{enum}	No	Return the data for the specified revision.
return_apps		bool	Yes	Return list of apps the items belong to

GETGetUserFiles

Retrieves files published by a user.

https://api.steampowered.com/IPublishedFileService/GetUserFiles/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes	Steam ID of the user whose files are being requested.
appid		uint32	Yes	App Id of the app that the files were published to.
shortcutid		uint32	No	Shortcut Id to retrieve published files from.
page		uint32	No	Starting page for results.
numperpage		uint32	No	The number of results, per page to return.
type		string	No	Type of files to be returned.
sortmethod		string	No	Sorting method to use on returned values.
privacy		uint32	No	Filter by privacy settings.
requiredtags		string	No	Tags that must be present on a published file to satisfy the query.
excludedtags		string	No	Tags that must NOT be present on a published file to satisfy the query.
required_kv_tags		{message}	Yes	Required key-value tags to match on.
filetype		uint32	No	File type to match files to.
creator_appid		uint32	Yes	App Id of the app that published the files, only matched if specified.
match_cloud_filename		string	Yes	Match this cloud filename if specified.
cache_max_age_seconds		uint32	No	Allow stale data to be returned for the specified number of seconds.
language		ELanguage	No	Specifies the localized text to return. Defaults to English.
taggroups		{message}	No	At least one of the tags must be present on a published file to satisfy the query.
excluded_content_descriptors		{enum}	No	Filter out items that have these content descriptors.
admin_query		bool	Yes	Admin tool is doing a query, return hidden items
totalonly		bool	No	If true, only return the total number of files that satisfy this query.
ids_only		bool	No	If true, only return the published file ids of files that satisfy this query.
return_vote_data		bool	No	Return vote data
return_tags		bool	Yes	Return tags in the file details
return_kv_tags		bool	No	Return key-value tags in the file details
return_previews		bool	Yes	Return preview image and video details in the file details
return_children		bool	Yes	Return child item ids in the file details
return_short_description		bool	No	Populate the short_description field instead of file_description
return_for_sale_data		bool	Yes	Return pricing information, if applicable
return_metadata		bool	No	Populate the metadata field
return_playtime_stats		uint32	Yes	Return playtime stats for the specified number of days before today.
strip_description_bbcode		bool	Yes	Strips BBCode from descriptions.
return_reactions		bool	No	If true, then reactions to items will be returned.
startindex_override		uint32	Yes	Backwards compatible for the client.
desired_revision		EPublishedFileRevision	No	Return the data for the specified revision.
return_apps		bool	Yes	Return list of apps the items belong to

Name	Value	Type	Required	Description
publishedfileids[0]		uint64[]	Yes

UNDOCUMENTEDPOSTPublish

Publishes a clouded user file to the Workshop.

https://api.steampowered.com/IPublishedFileService/Publish/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App Id this file is being published FROM.
consumer_appid		uint32	No	App Id this file is being published TO.
cloudfilename		string	No	Name of the file to publish in the user's cloud.
preview_cloudfilename		string	No	Name of the file to use as the published file's preview.
title		string	No	Text title for the published file.
file_description		string	No	Text description for the published file.
file_type		uint32	No	(EWorkshopFileType) Type of Workshop file to publish.
consumer_shortcut_name		string	No	Shortcut name for the published file.
youtube_username		string	No	User's YouTube account username.
youtube_videoid		string	No	Video Id of a YouTube video for this published file.
visibility		uint32	No	(ERemoteStoragePublishedFileVisibility) Visibility of the published file (private, friends, public, etc.)
redirect_uri		string	No	If supplied, the resulting published file's Id is appended to the URI.
tags[0]		string[]	No	Array of text tags to apply to the published file.
collection_type		string	No	Type of collection the published file represents.
game_type		string	No	Type of game the published file represents.
url		string	No	If this represents a game, this is the URL to that game's page.

GETQueryFiles

Performs a search query for published files

https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
query_type		EPublishedFileQueryType	Yes	enumeration EPublishedFileQueryType in clientenums.h
page		uint32	Yes	Current page
cursor		string	Yes	Cursor to paginate through the results (set to '*' for the first request). Prefer this over using the page parameter, as it will allow you to do deep pagination. When used, the page parameter will be ignored.
numperpage		uint32	No	The number of results, per page to return.
creator_appid		uint32	Yes	App that created the files
appid		uint32	Yes	App that consumes the files
requiredtags		string	Yes	Tags to match on. See match_all_tags parameter below
excludedtags		string	No	Tags that must NOT be present on a published file to satisfy the query.
match_all_tags		bool	No	If true, then items must have all the tags specified, otherwise they must have at least one of the tags.
required_flags		string	Yes	Required flags that must be set on any returned items
omitted_flags		string	Yes	Flags that must not be set on any returned items
search_text		string	Yes	Text to match in the item's title or description
filetype		uint32	Yes	EPublishedFileInfoMatchingFileType
child_publishedfileid		uint64	Yes	Find all items that reference the given item.
days		uint32	Yes	If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].
include_recent_votes_only		bool	Yes	If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given
cache_max_age_seconds		uint32	No	Allow stale data to be returned for the specified number of seconds.
language		ELanguage	No	Language to search in and also what gets returned. Defaults to English.
required_kv_tags		{message}	Yes	Required key-value tags to match on.
taggroups		{message}	No	At least one of the tags must be present on a published file to satisfy the query.
date_range_created		{message}	No	Filter to items created within this range.
date_range_updated		{message}	No	Filter to items updated within this range.
excluded_content_descriptors		{enum}	No	Filter out items that have these content descriptors.
admin_query		bool	Yes	Admin tool is doing a query, return hidden items
totalonly		bool	No	If true, only return the total number of files that satisfy this query.
ids_only		bool	No	If true, only return the published file ids of files that satisfy this query.
return_vote_data		bool	Yes	Return vote data
return_tags		bool	Yes	Return tags in the file details
return_kv_tags		bool	Yes	Return key-value tags in the file details
return_previews		bool	Yes	Return preview image and video details in the file details
return_children		bool	Yes	Return child item ids in the file details
return_short_description		bool	Yes	Populate the short_description field instead of file_description
return_for_sale_data		bool	Yes	Return pricing information, if applicable
return_metadata		bool	No	Populate the metadata
return_playtime_stats		uint32	Yes	Return playtime stats for the specified number of days before today.
return_details		bool	Yes	By default, if none of the other 'return_*' fields are set, only some voting details are returned. Set this to true to return the default set of details.
strip_description_bbcode		bool	Yes	Strips BBCode from descriptions.
desired_revision		EPublishedFileRevision	No	Return the data for the specified revision.
return_reactions		bool	No	If true, then reactions to items will be returned.

PUBLISHERPOSTRefreshVotingQueue

Refresh the voting queue for the user

https://partner.steam-api.com/IPublishedFileService/RefreshVotingQueue/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	Yes
matching_file_type		uint32	Yes	EPublishedFileInfoMatchingFileType
tags		string	Yes	Include files that have all the tags or any of the tags if match_all_tags is set to false.
match_all_tags		bool	No	If true, then files must have all the tags specified. If false, then must have at least one of the tags specified.
excluded_tags		string	Yes	Exclude any files that have any of these tags.
desired_queue_size		uint32	Yes	Desired number of items in the voting queue. May be clamped by the server
desired_revision		EPublishedFileRevision	No	Filter to items that have data for the specified revision.

PUBLISHERPOSTSetDeveloperMetadata

Sets the metadata for a developer on the published file

https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
appid		uint32	Yes
metadata		string	Yes

UNDOCUMENTEDPOSTSubscribe

Subscribes the user to the published file

https://api.steampowered.com/IPublishedFileService/Subscribe/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	No
list_type		uint32	No
appid		int32	No
notify_client		bool	No
include_dependencies		bool	No

UNDOCUMENTEDPOSTUnsubscribe

Unsubscribes the user from the published file

https://api.steampowered.com/IPublishedFileService/Unsubscribe/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	No
list_type		uint32	No
appid		int32	No
notify_client		bool	No

UNDOCUMENTEDPOSTUpdate

Updates information about a published file.

https://api.steampowered.com/IPublishedFileService/Update/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appid		uint32	No	App Id this published file belongs to.
publishedfileid		fixed64	No	Published file id of the file we'd like update.
title		string	No	Title of the published file.
file_description		string	No	Description of the published file.
visibility		uint32	No	Visibility of the published file.
tags[0]		string[]	No	Set of tags for the published file.
filename		string	No	Filename for the published file.
preview_filename		string	No	Preview filename for the published file.
spoiler_tag		bool	No	Whether this published file should have a spoiler tag attached to it.
image_width		uint32	No	If this is an image file, you can specify the image width.
image_height		uint32	No	If this is an image file, you can specify the image height.
language		int32	No	If setting title & description, what language to set

PUBLISHERPOSTUpdateAppUGCBan

Adds/updates/removes a UGC ban in the app

https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
steamid		uint64	Yes
appid		uint32	Yes
expiration_time		uint32	Yes
reason		string	Yes

PUBLISHERPOSTUpdateBanStatus

Updates the ban status on the item

https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
appid		uint32	Yes
banned		bool	Yes
reason		string	Yes

PUBLISHERPOSTUpdateIncompatibleStatus

Update the incompatible status on the item

https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
appid		uint32	Yes
incompatible		bool	Yes

PUBLISHERPOSTUpdateKeyValueTags

Updates key/value tags for a published file

https://partner.steam-api.com/IPublishedFileService/UpdateKeyValueTags/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
tags_to_add		{message}	Yes
tags_to_remove		{message}	Yes
string_tags_to_remove_by_key		string	Yes
int_tags_to_remove_by_key		string	Yes
appid		uint32	Yes

PUBLISHERPOSTUpdateTags

Updates tags on the published file

https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
appid		uint32	Yes
add_tags		string	Yes
remove_tags		string	Yes
language		ELanguage	Yes

PUBLISHERPOSTVote

User wants to vote on the item

https://partner.steam-api.com/IPublishedFileService/Vote/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
publishedfileid		uint64	Yes
vote_up		bool	Yes