Перейти к основному содержанию
GET
/
health
Liveness + freshness probe
curl --request GET \
  --url https://csboard.com/v1/health
{
  "status": "ok",
  "groups": 184213,
  "price_list_age_seconds": 42
}
Эндпоинт health — это лёгкая проверка, которая подтверждает доступность API и сообщает, насколько устарел материализованный список цен. Это единственный эндпоинт, работающий без API-ключа, поэтому его безопасно опрашивать из систем мониторинга или использовать как проверку свежести при старте приложения перед аутентифицированными вызовами.

​
Поля ответа

​
status
string
обязательно
Всегда "ok", когда сервис работает.
​
groups
integer
обязательно
Количество групп товаров с ценами в текущем списке цен (одна группа на уникальную комбинацию market_hash_name + wear + doppler_phase).
​
price_list_age_seconds
integer
обязательно
Возраст материализованного списка цен в секундах. Используйте это значение как индикатор свежести — большое значение означает, что цены могут отставать.

​
Пример запроса

curl https://csboard.com/v1/health

​
Пример ответа

{
  "status": "ok",
  "groups": 184213,
  "price_list_age_seconds": 42
}

​
Коды ошибок

HTTP-статусКодЗначение
429rate_limit_exceededПревышен лимит запросов. Подождите время, указанное в заголовке Retry-After, и повторите.
Опрашивайте этот эндпоинт из логики health-check или старта приложения перед аутентифицированными вызовами. Если price_list_age_seconds неожиданно велик (например, выше нескольких минут), считайте данные о ценах потенциально устаревшими.

Ответ

200 - application/json

Service is up.

​
status
string
обязательно
Пример:

"ok"

​
groups
integer
обязательно

Count of priced item groups.

​
price_list_age_seconds
integer
обязательно

Age of the materialized price list, in seconds (freshness).