kestrel-chartkitv0.11.3

CASOON Open Source

Indicator math, market regimes and signals, one bar at a time.

kestrel-chartkit is a Rust library for technical analysis. It streams bars through indicators, classifies the market regime, weighs indicator readings into one composite signal and draws the result as static SVG.

cargo add kestrel-chartkit
BUSL-1.1pre-1.0v0.11.3Rust 1.87+
Market regime per bar
indicators in the registry, built by name
105
golden-reference test suites
28
market regimes, from fixed and documented rules
4
required dependencies without default features
0

What it does

  1. Streaming by design

    Every indicator implements one trait, consumes one bar at a time and returns nothing until its warmup is complete.

  2. Built from configuration

    <code>catalog()</code> lists every indicator with its default parameters; <code>build_checked</code> rejects invalid periods and thresholds with an error instead of a panic.

  3. Signals you can explain

    Regime and composite score follow a handful of fixed thresholds. A direction against the regime is vetoed, and every signal carries its subscores.

  4. Pinned against independent references

    Numeric results are checked against values derived outside the crate: a second implementation, exact arithmetic or an unambiguous case.

  5. SVG without a front end

    Candles, indicator lines, zones and markers render to a self-contained SVG string. Colours can be CSS variables, so one chart serves light and dark pages.

Generated at build time

All examples →
Bollinger Bands (20, 2)

Every chart on this site is an SVG written by the crate's own renderer: cargo run --example site_showcase streams synthetic bars with fixed seeds through the indicators.

examples/site/bollinger-bands.svg

Quickstart

Add the crate from the repository, build an indicator by name and feed it bars. The full walkthrough lives in the documentation.

  1. Add the dependency, pinned to a release tag.
  2. Build an indicator from the registry with build_checked.
  3. Stream validated bars through on_bar and read the output.
Read the documentation
Cargo.tomlCargo.toml
[dependencies]
kestrel-chartkit = "0.11"
main.rsRust
use kestrel_chartkit::{build_checked, Bar, Indicator};
use std::collections::HashMap;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut params = HashMap::new();
    params.insert("rsi_len".to_string(), 14.0);
    let mut rsi = build_checked("rsi", &params)?;

    let bar = Bar::try_new(1700000000, 100.0, 105.0, 95.0, 104.0, 1000.0)?;
    if let Some(output) = rsi.on_bar(&bar) {
        println!("RSI Value: {:.2}", output.value);
    }
    Ok(())
}