Apps
Schema
Get the full stats and achievements schema for a Steam game, including display names, descriptions, and icon URLs.
Endpoint
This endpoint returns the complete schema for a Steam game's tracked stats and achievements, as published by the game's developer on Steam. Use it to resolve a stat's or achievement's internal identifier (as returned by the stats endpoint and the achievements endpoint) to a localized display name, description, and icon.
GET /v2/steam/apps/{appid}/schema
Required parameters
appid
number
The Steam application ID of the game whose schema you want to fetch.
Authentication
Include your API key as the x-api-key request header.
x-api-key: YourSecretAPIKey
Response fields
| Field | Type | Description |
|---|---|---|
gameName | string | The game's display name as reported by the schema. May be an empty string for some games. |
gameVersion | string | The schema version (a string, typically numeric). |
availableGameStats | object | Container for the game's stats and achievements definitions. |
availableGameStats.stats | array | Stat definitions. See fields below. |
availableGameStats.achievements | array | Achievement definitions. See fields below. |
Stat object
| Field | Type | Description |
|---|---|---|
name | string | The internal identifier of the stat. This is what the stats endpoint returns as stats[].name. |
defaultvalue | number | The stat's default value. |
displayName | string | Human-readable display name for the stat. May be an empty string when the developer has not defined one. |
Achievement object
| Field | Type | Description |
|---|---|---|
name | string | The internal identifier of the achievement. This is what the achievements endpoint returns as achievements[].name. |
defaultvalue | number | The achievement's default value (typically 0). |
displayName | string | Human-readable display name for the achievement. |
hidden | number | Whether the achievement is hidden until unlocked. 0 = visible, 1 = hidden. |
description | string|undefined | Description text for the achievement. Omitted for most hidden achievements (hidden: 1). |
icon | string | URL to the unlocked-state achievement icon. |
icongray | string | URL to the locked-state achievement icon. |
Response example
Example output for this endpoint. For brevity's sake, most stats and achievements were omitted.
response.json
{
"success": true,
"result": {
"gameName": "",
"gameVersion": "98",
"availableGameStats": {
"stats": [
{ "name": "deaths", "defaultvalue": 0, "displayName": "Deaths" },
{ "name": "bullet_fired", "defaultvalue": 0, "displayName": "Bullets Fired" },
{ "name": "kill_bear", "defaultvalue": 0, "displayName": "" }
],
"achievements": [
{
"name": "COLLECT_100_WOOD",
"defaultvalue": 0,
"displayName": "Collect Wood",
"hidden": 0,
"description": "Collect 100 Wood",
"icon": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/d896ed9975dc2b03acc89625ed7b70827354f625.jpg",
"icongray": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/6187dce1ff97cc7c07633f2d709f286fa8b4c719.jpg"
},
{
"name": "GLUTTON",
"defaultvalue": 0,
"displayName": "Glutton",
"hidden": 1,
"icon": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/3b9d9664a85847891233384f230e0b2ecfc92e01.jpg",
"icongray": "https://steamcdn-a.akamaihd.net/steamcommunity/public/images/apps/252490/07db7c83c3514799bd57ed7781ffeceb2dc90fe9.jpg"
}
]
}
}
}