CRYPTYX Docs
← API Reference
Canonical Harness

Quick scan - crowd, funding and volatility gauges across your coins

get/api/v1/heat-check

Three gauges (crowd, leverage, volatility) and a 0-3 heat score per coin, with universe position and a static out-of-sample evidence block. Relative ranking, not a price forecast. Each gauge carries one display label from its z-score: Overheated (>= 1.5), Running hot (0.5 to 1.5), Warm (> 0 to 0.5), Neutral (-0.5 to 0), Cool (-1.5 to -0.5), Very cool (<= -1.5); a gauge is hot (counts toward the score) exactly when its label is Warm, Running hot or Overheated. gauges[].detail is methodology only (display: false), e.g. the own-history percentile.

Authentication

Stytch session JWT or Bearer API key (cx_...).

Query parameters

assetsrequired
string
Comma-separated symbols, 1-25. asset= also accepted.
asof_day
string
YYYY-MM-DD. Defaults to the latest day with data.
compare_days
integer
Report what changed since this many days earlier (default 7; 0 = off).

Responses

200Gauge readings per coin
{
  "type": "object"
}

Example request

curl -X GET 'https://cryptyx.ai/api/v1/heat-check?assets=<assets>&asof_day=<asof_day>&compare_days=<compare_days>' \
  -H 'Authorization: Bearer cx_...'
Try it live in the Playground (auth required to execute).