Steam (Unofficial) API

Query Files

GET
/IPublishedFileService/QueryFiles/v1
key<token>

In: query

Query Parameters

query_type?integer

(Required) enumeration EPublishedFileQueryType in clientenums.h

Defaultnull
Formatint32
page?integer

(Required) Current page

Defaultnull
Formatint32
cursor?string

(Required) 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?integer

(Optional) The number of results, per page to return.

Defaultnull
Formatint32
creator_appid?integer

(Required) App that created the files

Defaultnull
Formatint32
appid?integer

(Required) App that consumes the files

Defaultnull
Formatint32
requiredtags?string

(Required) Tags to match on. See match_all_tags parameter below

excludedtags?string

(Optional) Tags that must NOT be present on a published file to satisfy the query.

match_all_tags?boolean

If true, then items must have all the tags specified, otherwise they must have at least one of the tags.

required_flags?string

(Required) Required flags that must be set on any returned items

omitted_flags?string

(Required) Flags that must not be set on any returned items

search_text?string

(Required) Text to match in the item's title or description

filetype?integer

(Required) EPublishedFileInfoMatchingFileType

Defaultnull
Formatint32
child_publishedfileid?integer

(Required) Find all items that reference the given item.

Defaultnull
Formatint64
days?integer

(Required) If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].

Defaultnull
Formatint32
include_recent_votes_only?boolean

(Required) 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?integer

Allow stale data to be returned for the specified number of seconds.

Defaultnull
Formatint32
language?integer

Language to search in and also what gets returned. Defaults to English.

Defaultnull
Formatint32
required_kv_tags?string

(Required) Required key-value tags to match on.

Format{message}
taggroups?string

(Optional) At least one of the tags must be present on a published file to satisfy the query.

Format{message}
date_range_created?string

(Optional) Filter to items created within this range.

Format{message}
date_range_updated?string

(Optional) Filter to items updated within this range.

Format{message}
excluded_content_descriptors?string

(Optional) Filter out items that have these content descriptors.

Format{enum}
admin_query?boolean

(Required) Admin tool is doing a query, return hidden items

totalonly?boolean

(Optional) If true, only return the total number of files that satisfy this query.

ids_only?boolean

(Optional) If true, only return the published file ids of files that satisfy this query.

return_vote_data?boolean

(Required) Return vote data

return_tags?boolean

(Required) Return tags in the file details

return_kv_tags?boolean

(Required) Return key-value tags in the file details

return_previews?boolean

(Required) Return preview image and video details in the file details

return_children?boolean

(Required) Return child item ids in the file details

return_short_description?boolean

(Required) Populate the short_description field instead of file_description

return_for_sale_data?boolean

(Required) Return pricing information, if applicable

return_metadata?boolean

Populate the metadata

return_playtime_stats?integer

(Required) Return playtime stats for the specified number of days before today.

Defaultnull
Formatint32
return_details?boolean

(Required) 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?boolean

(Required) Strips BBCode from descriptions.

desired_revision?string

Return the data for the specified revision.

Format{enum}
return_reactions?boolean

If true, then reactions to items will be returned.

input_json?string

An alternative to the query string parameters; pass arguments as a URL-encoded JSON blob. The "key" and "format" fields should still be passed as separate parameters

format?string

The format of the response. Defaults to json

Value in"json" | "xml" | "vdf"

Response Body

curl -X GET "https://api.steampowered.com/IPublishedFileService/QueryFiles/v1"
Empty
Empty
Empty