Быстрый старт

Получи свой Steam ID и API-ключ

Чтобы начать работу с SteamApis, войди через свой аккаунт Steam. После входа перейди на страницу настроек SteamApis, чтобы получить свой SteamID64 и API-ключ. API-ключ необходим для доступа ко всем endpoint'ам API.

Аутентификация

В v2 твой API-ключ нужно передавать через request header x-api-key. В качестве fallback'а можно также передать его как query-параметр 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);

Формат ответа

Все endpoint'ы v2 возвращают ответы в стандартном формате-обёртке:

Успешный ответ:

{
  "success": true,
  "response": {
    // данные конкретного endpoint'а
  }
}

Ответ с ошибкой:

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

HTTP-коды статуса

Все ответы API возвращаются в формате JSON. Проверяй HTTP-код статуса, чтобы определить, был ли запрос успешным:

• 200 OK — запрос выполнен успешно.
• 400 Bad Request — запрос не удалось понять или отсутствовали обязательные параметры.
• 401 Unauthorized — отсутствует или невалидный API-ключ.
• 403 Forbidden — доступ запрещён. У твоего аккаунта может быть недостаточно баланса или прав.
• 404 Not Found — запрошенный ресурс не найден.
• 429 Too Many Requests — превышен лимит запросов.
• 500 Internal Server Error — что-то пошло не так на нашей стороне.

Коды ошибок

Когда запрос завершается с ошибкой, ответ содержит поле message, помогающее определить проблему: