Apps
Schema
Obtém o schema completo de estatísticas e conquistas de um jogo Steam, incluindo nomes de exibição, descrições e URLs de ícones.
Endpoint
Este endpoint retorna o schema completo das estatísticas e conquistas rastreadas de um jogo Steam, conforme publicado pelo desenvolvedor na Steam. Usa-o para resolver o identificador interno de uma estatística ou conquista (como retornado pelo endpoint de stats e pelo endpoint de conquistas) para um nome de exibição localizado, descrição e ícone.
GET /v2/steam/apps/{appid}/schema
Parâmetros obrigatórios
appid
number
O Steam application ID do jogo cujo schema você quer buscar.
Autenticação
Inclua sua API key no header x-api-key.
x-api-key: YourSecretAPIKey
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
gameName | string | Nome de exibição do jogo conforme reportado pelo schema. Pode ser uma string vazia para alguns jogos. |
gameVersion | string | Versão do schema (string, normalmente numérica). |
availableGameStats | object | Container para as definições de estatísticas e conquistas do jogo. |
availableGameStats.stats | array | Definições de estatísticas. Vê os campos abaixo. |
availableGameStats.achievements | array | Definições de conquistas. Vê os campos abaixo. |
Objeto de estatística
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Identificador interno da estatística. É o valor que o endpoint de stats retorna como stats[].name. |
defaultvalue | number | Valor padrão da estatística. |
displayName | string | Nome de exibição legível da estatística. Pode ser uma string vazia quando o desenvolvedor não definiu nenhum. |
Objeto de conquista
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Identificador interno da conquista. É o valor que o endpoint de conquistas retorna como achievements[].name. |
defaultvalue | number | Valor padrão da conquista (normalmente 0). |
displayName | string | Nome de exibição legível da conquista. |
hidden | number | Se a conquista fica oculta até ser desbloqueada. 0 = visível, 1 = oculta. |
description | string|undefined | Texto de descrição da conquista. Omitido na maioria das conquistas ocultas (hidden: 1). |
icon | string | URL para o ícone do estado desbloqueado da conquista. |
icongray | string | URL para o ícone do estado bloqueado da conquista. |
Exemplo de resposta
Exemplo de output para este endpoint. Por brevidade, a maioria das estatísticas e conquistas foi omitida.
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"
}
]
}
}
}