Appearance
Return Skewness
Family: Risk
What it computes
Emits ReturnSkewnessTick ticks carrying mean_return, second_moment, third_moment, skewness, n_intraday_bars off stock trade tape (5m bars).
Available on the live, historical, and replay drives.
Methodology
Welford (1962) standardised third central moment of per-bar log returns S = m_3 / m_2^{3/2} over a rolling window — Harvey / Siddique (2000) crash-asymmetry signal.
See the methodology overview for the citation index.
Inputs
Stock trade tape (5m bars).
Key outputs
Mean_return, second_moment, third_moment, skewness, n_intraday_bars. The full field set is in the tick table below.
Output schema (ReturnSkewnessTick)
The field / type / description table below is regenerated from the ReturnSkewnessTick 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 mean per-bar log return μ_1. NaN before three bars have sealed. |
second_moment | f64 | Rolling-window second central moment m_2 = (1 / N) · Σ (r_i − μ_1)². NaN before three bars have sealed. |
third_moment | f64 | Rolling-window third central moment m_3 = (1 / N) · Σ (r_i − μ_1)³. NaN before three bars have sealed. |
skewness | f64 | Standardised return skewness S = m_3 / m_2^{3/2}. NaN before three bars have sealed; 0.0 for the flat-distribution degenerate case. |
n_intraday_bars | i32 | Count of intraday bars currently inside the rolling window. |
Configuration (ReturnSkewnessParams)
Regenerated from the ReturnSkewnessParams 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). |
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().return_skewness(["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()
.returnSkewness(["QQQ"])
.onEvent((tick) => {
console.log(tick);
});Rust
rust
// Cargo.toml:
// kairos = "0.1"
use kairos::{Client, ReturnSkewnessRow};
# fn run() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::connect(("me@example.com", "secret"))?;
let sub = client
.live()
.return_skewness(["QQQ"])
.on_event(|row: &ReturnSkewnessRow| println!("mean_return={} third_moment={}", row.mean_return, row.third_moment))?;
// ... later ...
sub.unsubscribe();
# Ok(())
# }