Рыночные данные

Обзор REST

Базовый URL, аутентификация, формат ответа и ошибки для REST API рыночных данных.

Обзор

REST API рыночных данных предоставляет доступ к листингам предметов, заявкам на покупку, истории цен и данным о продажах с сторонних Steam-маркетплейсов. Это отдельный сервис от основного Steam API, работающий на собственном хосте.

Это API документирует транспорт REST. Для потока в реальном времени смотрите WebSocket. Оба транспорта используют одни и те же торговые площадки — смотрите Справочник.

Базовый URL

Все REST-эндпоинты обслуживаются с единственного хоста.

https://marketplaceapi.steamapis.com/v2/

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

Указывайте свой API-ключ в заголовке запроса X-API-Key. HTTP-заголовки не чувствительны к регистру, поэтому x-api-key также работает.

X-API-Key: YourSecretAPIKey

Альтернативно передайте ключ как параметр запроса apiKey. Заголовок предпочтительнее.

https://marketplaceapi.steamapis.com/v2/marketplaces?apiKey=YourSecretAPIKey

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

Ответы представляют собой плоский JSON. В отличие от Steam API, это API не оборачивает ответы в конверт { "success": true, "response": {...} }. Парсите тело ответа напрямую.

Успешный ответ — это либо единичный объект, либо массив объектов, в зависимости от эндпоинта. Например, GET /v2/marketplaces возвращает массив напрямую на верхнем уровне тела.

Ошибки

Ошибки возвращаются с HTTP-статусом, отличным от 2xx, и JSON-телом, содержащим сообщение error и машиночитаемый code.

error.json
{
  "error": "Marketplace not found",
  "code": "NOT_FOUND"
}

Кэширование и лимиты запросов

Ответы кэшируются на стороне сервера в течение 10 секунд. Клиентских лимитов запросов нет — кэш поглощает повторяющийся трафик.

Доступные эндпоинты