Skip to main content
GET
Aggregate trade volume/pressure metrics for a contract window

Authorizations

X-Client-Id
string
header
required

Credential client id (kairos_ck_...). Must be sent together with X-Api-Key and X-Api-Secret.

X-Api-Key
string
header
required

64-char hex API key. Must be sent together with X-Client-Id and X-Api-Secret.

X-Api-Secret
string
header
required

64-char hex API secret. Must be sent together with X-Client-Id and X-Api-Key.

Query Parameters

provider
enum<string>
required

Venue identifier, case-insensitive. kalshi_offchain aliases kalshi; dome aliases polymarket. Whether provider resolves to Kalshi determines which aggregation query runs — see the operation description.

Available options:
kalshi,
kalshi_offchain,
polymarket,
dome,
opinion,
predictfun,
hyperliquid
contract_id
string
required

Venue-scoped contract/token identifier to compute metrics for.

window_seconds
integer
default:86400

Trailing window, in seconds, measured back from the current server time. Valid range [3600, 86400]; out-of-range or non-integer values are rejected with 400.

Required range: 3600 <= x <= 86400

Response

Aggregated metrics for the window. Present with all-zero volumes (and coverage_pct: 0) rather than a 404 when no trades exist.

metrics
object
required