Início rápido

Obtenha seu Steam ID e API key

Para começar a usar o SteamApis, faça login com sua conta Steam. Depois de logado, vá para a página de Configurações do SteamApis para pegar seu SteamID64 e sua API key. A API key é essencial para acessar todos os endpoints da API.

Autenticação

Na v2, sua API key deve ser passada pelo header x-api-key. Como fallback, você também pode passá-la como query parameter key.

const API_KEY = '1nqNbqP5JYQ9Lpw5nATfKumaxN0';

const response = await fetch('https://api.steamapis.com/v2/steam/users/76561198038526790', {
  headers: {
    'x-api-key': API_KEY
  }
});

const data = await response.json();
console.log(data);

Formato de resposta

Todos os endpoints v2 retornam respostas em um formato de envelope padrão:

Resposta de sucesso:

{
  "success": true,
  "response": {
    // dados específicos do endpoint
  }
}

Resposta de erro:

{
  "success": false,
  "error": {
    "name": "BadRequestError",
    "message": "NOT_FOUND",
    "meta": null
  }
}

Códigos de status HTTP

Todas as respostas da API são retornadas em formato JSON. Verifique o código de status HTTP para saber se sua request foi bem-sucedida:

• 200 OK - a request foi bem-sucedida.
• 400 Bad Request - a request não pôde ser entendida ou faltam parâmetros obrigatórios.
• 401 Unauthorized - API key ausente ou inválida.
• 403 Forbidden - acesso negado. Sua conta pode não ter saldo ou permissões suficientes.
• 404 Not Found - o recurso solicitado não foi encontrado.
• 429 Too Many Requests - limite de rate excedido.
• 500 Internal Server Error - algo deu errado do nosso lado.

Códigos de erro

Quando uma request falha, a resposta de erro inclui um campo message para ajudar a identificar o problema: