Difference between revisions of "WebAPI/GetOwnedGames"

From Team Fortress Wiki
Jump to: navigation, search
m
(Updated info for appids_filter)
 
Line 6: Line 6:
 
;{{API optional|include_appinfo}} ''(bool)'': Whether or not to include additional details of apps - name and images.  Defaults to false.
 
;{{API optional|include_appinfo}} ''(bool)'': Whether or not to include additional details of apps - name and images.  Defaults to false.
 
;{{API optional|include_played_free_games}} ''(bool)'': Whether or not to list free-to-play games in the results.  Defaults to false.
 
;{{API optional|include_played_free_games}} ''(bool)'': Whether or not to list free-to-play games in the results.  Defaults to false.
;{{API optional|appids_filter}} ''(uint32)'': Restricts results to the appids passed here; does not seem to work as of 31 Mar 2013.
+
;{{API optional|appids_filter}} ''(uint32)'': Restricts results to the appids passed here. This is an array and should be passed like appids_filter[0]=440&appids_filter[1]=570
  
 
== Result data ==
 
== Result data ==

Latest revision as of 03:10, 20 January 2015

URL

GET http://api.steampowered.com/IPlayerService/GetOwnedGames/v1

Method-specific parameters

steamid (Optional) (uint64)
The 64 bit ID of the player.
include_appinfo (Optional) (bool)
Whether or not to include additional details of apps - name and images. Defaults to false.
include_played_free_games (Optional) (bool)
Whether or not to list free-to-play games in the results. Defaults to false.
appids_filter (Optional) (uint32)
Restricts results to the appids passed here. This is an array and should be passed like appids_filter[0]=440&appids_filter[1]=570

Result data

response
game_count
Total number of results.
games
An array of results.
appid
An integer containing the program's ID.
name (Optional)
A string containing the program's publicly facing title.
playtime_2weeks (Optional)
An integer of the player's playtime in the past 2 weeks, denoted in minutes.
playtime_forever (Optional)
An integer of the the player's total playtime, denoted in minutes.
img_icon_url (Optional)
The program icon's file name, accessible at: http://media.steampowered.com/steamcommunity/public/images/apps/APPID/IMG_ICON_URL.jpg, replacing "APPID" and "IMG_ICON_URL" as necessary.
img_logo_url (Optional)
The program logo's file name, accessible at: http://media.steampowered.com/steamcommunity/public/images/apps/APPID/IMG_LOGO_URL.jpg, replacing "APPID" and "IMG_LOGO_URL" as necessary.
has_community_visible_stats (Optional)
Whether the program has stats accessible via GetUserStatsForGame and GetGlobalStatsForGame.