Skip to main content
GET
/
health
Liveness + freshness probe
curl --request GET \
  --url https://csboard.com/v1/health
{
  "status": "ok",
  "groups": 184213,
  "price_list_age_seconds": 42
}
The health endpoint is a lightweight probe that confirms the API is reachable and tells you how stale the materialized price list is. It is the only endpoint that works without an API key, making it safe to poll from monitoring systems or to gate your application startup on a freshness check before making authenticated calls.

​
Response fields

​
status
string
required
Always "ok" when the service is up.
​
groups
integer
required
Count of priced item groups currently in the price list (one group per unique market_hash_name + wear + doppler_phase combination).
​
price_list_age_seconds
integer
required
Age of the materialized price list in seconds. Use this as a freshness indicator — a large value means prices may be lagging.

​
Example request

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

​
Example response

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

​
Error codes

HTTP statusCodeMeaning
429rate_limit_exceededOver the request rate limit. Back off and retry after the Retry-After header value.
Poll this endpoint from your health-check or startup logic before making authenticated calls. If price_list_age_seconds is unexpectedly large (e.g. above a few minutes), treat downstream price data as potentially stale.

Response

200 - application/json

Service is up.

​
status
string
required
Example:

"ok"

​
groups
integer
required

Count of priced item groups.

​
price_list_age_seconds
integer
required

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