Omega Ratio

Family: Risk

What it computes

Emits OmegaRatioTick ticks carrying threshold, upside_expectation, downside_expectation, omega_ratio, n_intraday_bars off stock trade tape (5m bars).

Available on the live, historical, and replay drives.

Methodology

Keating / Shadwick (2002) probability-weighted gain / loss ratio Ω(τ) = E[max(r − τ, 0)] / E[max(τ − r, 0)] over rolling window per-bar return FIFO.

See the methodology overview for the citation index.

Inputs

Stock trade tape (5m bars).

Key outputs

Threshold, upside_expectation, downside_expectation, omega_ratio, n_intraday_bars. The full field set is in the tick table below.

Output schema (OmegaRatioTick)

The field / type / description table below is regenerated from the OmegaRatioTick Rust source by docs-site/scripts/inject-doc-tables.ts on every npm run docs:build. Do not hand-edit between the sentinels.

Field	Type	Description
symbol	Arc<str>	Underlying symbol (interned).
date	i32	Trading-session date (YYYYMMDD) at emission time.
ms_of_day	i32	Milliseconds since midnight ET at emission time.
threshold	f64	Threshold τ the Omega ratio was fit against.
upside_expectation	f64	Probability-weighted upside expectation E[max(r − τ, 0)].
downside_expectation	f64	Probability-weighted downside expectation E[max(τ − r, 0)]. Strictly positive on every emitted row — the Omega ratio is undefined when the loss integral is zero (Keating & Shadwick 2002), and undefined states suppress the emission.
omega_ratio	f64	Omega ratio Ω(τ) = upside / downside. Always finite and non-negative: rows publish only when the downside expectation is strictly positive.
n_intraday_bars	i32	Count of intraday bars currently inside the rolling window.

Configuration (OmegaRatioParams)

Regenerated from the OmegaRatioParams Rust source — see the note above.

Field	Type	Description
contracts	SecurityFilter	Contracts the subscription tracks. Stocks only — the analytic silently ignores option / index trades at the on_tick entry point.
conditions	ConditionPolicy	Trade-condition admission policy applied to every print.
venues	ExchangeFilter	Exchange / venue admission policy.
bar_interval_ms	i32	Per-bar cadence in milliseconds. Defaults to [DEFAULT_BAR_INTERVAL_MS] (300_000 ms / 5 min).
window_bars	i32	Rolling-window length in bars. Defaults to [DEFAULT_WINDOW_BARS] (78 — one US-equity session at the default 5-minute cadence).
threshold	f64	Threshold-of-acceptance τ — per-bar log return units. Defaults to [DEFAULT_THRESHOLD] (0.0).
min_emit_interval_ms	i32	Minimum interval between consecutive emissions per symbol, in milliseconds. Defaults to [DEFAULT_MIN_EMIT_INTERVAL_MS] (60_000 ms). Set to 0 to publish on every sealed bar.

Example

Python

import kairos_thetadata as kt

client = kt.Client.connect(kt.Credentials.from_env())

def on_event(row):
    print(row)

sub = client.live().omega_ratio(["QQQ"]).on_event(on_event)
sub.wait(timeout_seconds=60.0)

TypeScript

import { Client, Credentials } from "kairos-thetadata";

const client = await Client.connect(Credentials.fromEnv());

await client
  .live()
  .omegaRatio(["QQQ"])
  .onEvent((tick) => {
    console.log(tick);
  });

Rust

// Cargo.toml:
//   kairos = "0.1"

use kairos::{Client, OmegaRatioRow};

# fn run() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::connect(("me@example.com", "secret"))?;

let sub = client
    .live()
    .omega_ratio(["QQQ"])
    .on_event(|row: &OmegaRatioRow| println!("upside={} downside={}", row.upside_expectation, row.downside_expectation))?;

// ... later, to stop delivery ...
sub.unsubscribe();
# Ok(())
# }