Difference between revisions of "User:RJackson/StorefrontAPI"

From Team Fortress Wiki
Jump to: navigation, search
(WIP)
 
(appdetails "filter" parameter. appdetails return data.)
Line 18: Line 18:
 
::* partial
 
::* partial
 
::* full
 
::* full
 +
:;{{API optional|purchase_package}}: Subscription ID for purchasing the app.
  
 
== Known methods ==
 
== Known methods ==
Line 50: Line 51:
 
::;id:
 
::;id:
 
::;name:
 
::;name:
−
::;items: Array
+
::;items: An array of objects, with differing app structures dependant upon '''''N'''''.id:
−
:::;name:
+
:::;cat_spotlight:
−
:::;header_image:
+
::::;name:
−
:::;body:
+
::::;header_image:
−
:::;url:
+
::::;body:
 +
::::;url:
 +
:::;cat_dailydeal: See [[#App info]]
 
:;specials:
 
:;specials:
 
::;id:
 
::;id:
Line 86: Line 89:
 
:;{{API optional|l}}: Language code for localized strings.
 
:;{{API optional|l}}: Language code for localized strings.
 
:;{{API optional|v}}: Unknown.
 
:;{{API optional|v}}: Unknown.
 +
:;{{API optional|filters}}: CSV list of keys to return, e.g. <code>filters=screenshots</code> only returns an appid's screenshots.
  
 
==== Result data ====
 
==== Result data ====
 +
:;''App ID'':
 +
::;success:
 +
::;data:
 +
:::;type: Returns "game" even if software.
 +
:::;name:
 +
:::;steam_appid:
 +
:::;required_age:
 +
:::;{{API optional|dlc}}: Array of app ids.
 +
:::;detailed_description: String (html).
 +
:::;about_the_game: String (html).
 +
:::;supported_languages: String (html).
 +
:::;header_image: URL to image.
 +
:::;website:
 +
:::;pc_requirements: Array
 +
::::;minimum: String (html).
 +
::::;recommended: String (html).
 +
:::;mac_requirements: Array
 +
::::;minimum: String (html).
 +
::::;recommended: String (html).
 +
:::;developers: Array of strings
 +
:::;publishers: Array of strings.
 +
:::;packages: Array of package IDs.
 +
:::;{{API optional|price_overview}}: Omitted if free-to-play.
 +
::::;currency: Currency prices are denoted in.
 +
::::;initial: Pre-discount price.
 +
::::;final: Post-discount price.
 +
::::;discount_percent:
 +
:::;platforms: Booleans. Does not list Linux.
 +
::::;windows:
 +
::::;mac:
 +
:::;{{API optional|metacritic}}:
 +
::::;score:
 +
::::;url:
 +
:::;categories:Array.
 +
::::;id:
 +
::::;description:
 +
:::;genres:Array.
 +
::::;id:
 +
::::;description:
 +
:::;screenshots: Array.
 +
::::;id:
 +
::::;path_thumbnail: URL to image.
 +
::::;path_full: URL to image.
 +
:::;movies: Array.
 +
::::;id:
 +
::::;name:
 +
::::;thumbnail:
 +
::::;webm:
 +
:::::;480: URL of 480p video.
 +
:::::;max: URL of max-quality video.
 +
::::;highlight: Boolean; not sure it's purpose.
 +
:::;recommendations:
 +
::::;total: Int
 +
:::;{{API optional|achievements}}:
 +
::::;total: Int
 +
::::;highlighted: Array
 +
:::::;name:
 +
:::::;path: URL to achievement icon.
 +
:::;release_date:
 +
::::;coming_soon: Boolean, true if unreleased; false if released.
 +
::::;date: d MMM yyyy; check if localized.  Blank if unannounced.
 +
 +
  
 
=== appuserdetails ===
 
=== appuserdetails ===

Revision as of 21:50, 24 April 2013

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
purchase_package (Optional)
Subscription ID for purchasing the app.

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
An array of objects, with differing app structures dependant upon N.id:
cat_spotlight
name
header_image
body
url
cat_dailydeal
See #App info
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.
filters (Optional)
CSV list of keys to return, e.g. filters=screenshots only returns an appid's screenshots.

Result data

App ID
success
data
type
Returns "game" even if software.
name
steam_appid
required_age
dlc (Optional)
Array of app ids.
detailed_description
String (html).
about_the_game
String (html).
supported_languages
String (html).
header_image
URL to image.
website
pc_requirements
Array
minimum
String (html).
recommended
String (html).
mac_requirements
Array
minimum
String (html).
recommended
String (html).
developers
Array of strings
publishers
Array of strings.
packages
Array of package IDs.
price_overview (Optional)
Omitted if free-to-play.
currency
Currency prices are denoted in.
initial
Pre-discount price.
final
Post-discount price.
discount_percent
platforms
Booleans. Does not list Linux.
windows
mac
metacritic (Optional)
score
url
categories
Array.
id
description
genres
Array.
id
description
screenshots
Array.
id
path_thumbnail
URL to image.
path_full
URL to image.
movies
Array.
id
name
thumbnail
webm
480
URL of 480p video.
max
URL of max-quality video.
highlight
Boolean; not sure it's purpose.
recommendations
total
Int
achievements (Optional)
total
Int
highlighted
Array
name
path
URL to achievement icon.
release_date
coming_soon
Boolean, true if unreleased; false if released.
date
d MMM yyyy; check if localized. Blank if unannounced.


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.
Retrieved from "https://wiki.teamfortress.com/w/index.php?title=User:RJackson/StorefrontAPI&oldid=1338412"