Difference between revisions of "WebAPI/GetSchemaForGame"

From Team Fortress Wiki
Jump to: navigation, search
(lagg fix)
('''Main article about WebAPI.''')
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
'''Main article about [[WebAPI]].'''
 
== URL ==
 
== URL ==
 
<nowiki>GET http://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v2</nowiki>
 
<nowiki>GET http://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v2</nowiki>
Line 7: Line 8:
  
 
== Result data ==
 
== Result data ==
 +
;game:
 +
:;gameName (string): Steam internal (non-localized) name of game.
 +
:;gameVersion (int): Steam release version number currently live on Steam.
 +
:;availableGameStats:
 +
::;{{API optional|achievements}} (array):
 +
:::;name (string): API Name of achievement.
 +
:::;defaultvalue (int): Always 0 (player's default state is unachieved).
 +
:::;displayName (string): Display title string of achievement.
 +
:::;hidden (int): If achievement is hidden to the user before earning achievement, value is 1. 0 if public.
 +
:::;description (string): Display description string of achievement.
 +
:::;icon (string): Absolute URL of earned achievement icon art.
 +
:::;icongray (string): Absolute URL of un-earned achievement icon art.
 +
::;{{API optional|stats}} (array):
 +
:::;name (string): API name of stat.
 +
:::;defaultvalue (int): Default value of stat.
 +
:::;displayName (string): Developer provided name of string.
 +
 +
[[Category:WebAPI]]

Latest revision as of 20:15, 18 December 2021

Main article about WebAPI.

URL

GET http://api.steampowered.com/ISteamUserStats/GetSchemaForGame/v2

Method-specific parameters

appid (uint32)
appid of game
l (Optional) (string)
localized language to return (english, french, etc.)

Result data

game
gameName (string)
Steam internal (non-localized) name of game.
gameVersion (int)
Steam release version number currently live on Steam.
availableGameStats
achievements (Optional) (array)
name (string)
API Name of achievement.
defaultvalue (int)
Always 0 (player's default state is unachieved).
displayName (string)
Display title string of achievement.
hidden (int)
If achievement is hidden to the user before earning achievement, value is 1. 0 if public.
description (string)
Display description string of achievement.
icon (string)
Absolute URL of earned achievement icon art.
icongray (string)
Absolute URL of un-earned achievement icon art.
stats (Optional) (array)
name (string)
API name of stat.
defaultvalue (int)
Default value of stat.
displayName (string)
Developer provided name of string.