Developers API

Realtime Event Engine

WebSocket streaming, event webhooks, payload schemas, rule conditions, delivery lifecycle, signature verification, event history, and errors.

Event Types & Conditions

Supported realtime event types and their condition selectors.

Event Type	Conditions
price_alert	price_above, price_below, pct_change
large_move	pct_change_abs_gte
abnormal_volume	ratio_gte
unusual_value_traded	ratio_gte

conditions_matched Contracts

Event-specific shape differences are primarily expressed in conditions_matched.

json

{
  "price_alert": {
    "price_above": { "operator": ">", "observed": 26.1, "threshold": 26.0 },
    "price_below": { "operator": "<", "observed": 24.8, "threshold": 25.0 },
    "pct_change": { "operator": "abs>=", "observed": 3.2, "threshold": 3.0 }
  },
  "large_move": {
    "window": "15m",
    "operator": "abs>=",
    "observed_pct_change": 3.4,
    "threshold_pct": 3.0,
    "baseline_price": 25.01,
    "current_price": 25.86
  },
  "abnormal_volume": {
    "event_type": "abnormal_volume",
    "operator": ">=",
    "metric": "volume_ratio",
    "current_value": 9803705,
    "baseline_value": 4100000,
    "ratio": 2.39,
    "threshold": 2.0
  },
  "unusual_value_traded": {
    "event_type": "unusual_value_traded",
    "operator": ">=",
    "metric": "value_ratio",
    "current_value": 252308343.0,
    "baseline_value": 120000000.0,
    "ratio": 2.1,
    "threshold": 2.0
  }
}

Numeric encoding is JSON number (not string). ratio and observed_pct_change are rounded to 4 decimals.