Skip to main content
GET
Fetch volume and outcome-pressure metrics for a contract

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.

X-Api-Secret
string
header
required

64-char hex API secret.

Query Parameters

provider
string
required

Venue identifier, matched case-insensitively against the live provider registry.

contract_id
string
required

Provider-specific contract identifier. Empty or >128 chars returns 400.

Required string length: 1 - 128
window_seconds
integer
default:86400

Lookback window in seconds, ending "now". Clamped to [3600, 86400] (1 hour to 24 hours).

Required range: 3600 <= x <= 86400
trigger_ingest
boolean
default:false

If true, triggers ingestion when coverage for this window is low, rather than computing metrics from partial/stale data alone.

Response

Aggregate volume/pressure metrics for the window.

metrics
object
required

Aggregate volume/pressure metrics. Split by outcome (outcome_0 vs outcome_1), not by buy/sell direction — trade direction is not reliably derivable from every provider's exchange data.