Garman Klass Explicit

Family: Volatility

What it computes

Emits GarmanKlassExplicitTick ticks carrying realized_vol, bar_variance, n_intraday_bars off stock trade tape (5m bars).

Available on the live, historical, and replay drives.

Methodology

Garman / Klass (1980) OHLC realized volatility σ²_GK = 0.5 · ln(H/L)² − (2·ln 2 − 1) · ln(C/O)² aggregated over a rolling per-bar (O, H, L, C) window.

See the methodology overview for the citation index.

Inputs

Stock trade tape (5m bars).

Key outputs

Realized_vol, bar_variance, n_intraday_bars. The full field set is in the tick table below.

Output schema (GarmanKlassExplicitTick)

The field / type / description table below is regenerated from the GarmanKlassExplicitTick 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.
realized_vol	f64	Garman / Klass (1980) annualised realized volatility over the rolling-window per-bar (O, H, L, C) ladder. NaN with an empty FIFO.
bar_variance	f64	Garman / Klass (1980) per-bar variance averaged across the window (per-bar units, pre-annualisation). NaN with an empty FIFO. May be slightly negative under finite-sample variation when the open-close drift dominates the high-low range; the annualised vol is clamped at zero.
n_intraday_bars	i32	Count of sealed per-bar OHLC quadruples currently inside the rolling window.

Configuration (GarmanKlassExplicitParams)

Regenerated from the GarmanKlassExplicitParams 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).
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().garman_klass_explicit(["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()
  .garmanKlassExplicit(["QQQ"])
  .onEvent((tick) => {
    console.log(tick);
  });

Rust

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

use kairos::{Client, GarmanKlassExplicitRow};

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

let sub = client
    .live()
    .garman_klass_explicit(["QQQ"])
    .on_event(|row: &GarmanKlassExplicitRow| println!("realized_vol={}", row.realized_vol))?;
// ... later ...
sub.unsubscribe();
# Ok(())
# }