User:RJackson/StorefrontAPI

From Team Fortress Wiki
< User:RJackson
Revision as of 09:42, 24 April 2013 by RJackson (talk | contribs) (WIP)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Rough documentation for the storefront API - exposed via Big Picture mode. Data is returned in JSON format.

Shared data structures

App info

id
type
name
discounted
discounted_percent
original_price
Pre-discount application price.
final_price
Post-discount application price.
currency
What currency prices are denoted in.
large_capsule_image
URL of large-capsule image.
small_capsule_image
URL of small-capsule image.
discount_expiration (Optional)
Unix timestamp of when the discount noted above :expires. Is not provided if the app is not discounted.
headline (Optional)
Headline to atop large-capsule widget.
controller_support (Optional)
Whether the app has controller support. Known values:
  • partial
  • full

Known methods

featured

Data about apps featured on storefront.

GET http://store.steampowered.com/api/featured/

Parameters

cc (Optional)
Country code for method to return appropriate currency values.
l (Optional)
Language code for localized strings.
v (Optional)
Unknown.

Result data

large_capsules
An array of objects denoting app information; see #App info.
featured_win
An array of objects denoting app information; see #App info.
featured_mac
An array of objects denoting app information; see #App info.
layout
status

featuredcategories

Even more data about featured apps.

GET http://store.steampowered.com/api/featuredcategories/

Parameters

cc (Optional)
Country code for method to return appropriate currency values.
l (Optional)
Language code for localized strings.
v (Optional)
Unknown.
trailer (Optional)
Unknown.

Result data

N
id
name
items
Array
name
header_image
body
url
specials
id
name
items
An array of objects denoting app information; see #App info.
coming_soon
id
name
items
An array of objects denoting app information; see #App info.
top_sellers
id
name
items
An array of objects denoting app information; see #App info.
new_releases
id
name
items
An array of objects denoting app information; see #App info.
genres
id
name
trailerslideshow
id
name
status

appdetails

GET http://store.steampowered.com/api/appdetails/

Parameters

appids
CSV of app IDs to return details of.
cc (Optional)
Country code for method to return appropriate currency values.
l (Optional)
Language code for localized strings.
v (Optional)
Unknown.

Result data

appuserdetails

GET http://store.steampowered.com/api/appuserdetails/

Parameters

appids
CSV of app IDs to return details of.
cc (Optional)
Country code for method to return appropriate currency values.
l (Optional)
Language code for localized strings.
v (Optional)
Unknown.