Appearance
VaR Parametric
Family: Risk
What it computes
Emits VarParametricTick ticks carrying mean_return, std_dev, var_95, var_99, n_intraday_bars off stock trade tape (5m bars).
Available on the live, historical, and replay drives.
Methodology
J.P. Morgan RiskMetrics (1996) Gaussian-assumption parametric VaR VaR_α = −(μ + z_α · σ) over a rolling per-bar return window.
See the methodology overview for the citation index.
Inputs
Stock trade tape (5m bars).
Key outputs
Mean_return, std_dev, var_95, var_99, n_intraday_bars. The full field set is in the tick table below.
Output schema (VarParametricTick)
The field / type / description table below is regenerated from the VarParametricTick 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. |
mean_return | f64 | Rolling-window sample mean per-bar log return μ. NaN before two bars have sealed. |
std_dev | f64 | Rolling-window sample standard deviation σ (Bessel- corrected). NaN before two bars have sealed. |
var_95 | f64 | Gaussian parametric one-bar Value-at-Risk at the 95% confidence level. NaN before two bars have sealed. |
var_99 | f64 | Gaussian parametric one-bar Value-at-Risk at the 99% confidence level. NaN before two bars have sealed. |
n_intraday_bars | i32 | Count of intraday bars currently inside the rolling window. |
Configuration (VarParametricParams)
Regenerated from the VarParametricParams 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
python
import kairos_thetadata as kt
client = kt.Client.connect(kt.Credentials.from_env())
def on_event(row):
print(row)
sub = client.live().var_parametric(["QQQ"]).on_event(on_event)
sub.wait(timeout_seconds=60.0)TypeScript
typescript
import { Client, Credentials } from "kairos-thetadata";
const client = await Client.connect(Credentials.fromEnv());
await client
.live()
.varParametric(["QQQ"])
.onEvent((tick) => {
console.log(tick);
});Rust
rust
// Cargo.toml:
// kairos = "0.1"
use kairos::{Client, VarParametricRow};
# fn run() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::connect(("me@example.com", "secret"))?;
let sub = client
.live()
.var_parametric(["QQQ"])
.on_event(|row: &VarParametricRow| println!("var_95={} var_99={}", row.var_95, row.var_99))?;
// ... later ...
sub.unsubscribe();
# Ok(())
# }