fintech-algorithms
Using a coding agent? Give it the skill: npx skills add IslamBaraka90/Fintech-Algorithms-Library What it does →

Chaikin Volatility

Install and import#

bash
npm install fintech-algorithms
ts
import { chaikinVolatility } from "fintech-algorithms/technical-indicators/range-and-volatility-indicators/chaikin-volatility";

Signature#

chaikinVolatility(input)

Chaikin Volatility: the percentage change, roc_period bars apart, in an exponential moving average of the bar's high-low range.

Parameters#

NameTypeNotes
inputTopicInputbars is the required OHLCV array -- each bar carries timestamp, open, high, low, close, volume and an optional basis, strictly ordered by timestamp. From parameters this topic reads period (default 14, integer >= 2), the EMA length applied to high - low, and roc_period (default 10, integer >= 1), the rate-of-change lookback.

Returns#

TopicResult

series holds a single key, value, the percentage change in the smoothed range; latest.value is its last reading. The warm-up is period - 1 + roc_period leading nulls, so ready_at is 23 at the defaults.

Warm-up#

The first `period - 1 + roc_period` bars (23 at the defaults) positions are null. The EMA of the range seeds at index period - 1, and the rate of change needs a smoothed value roc_period bars earlier. value is additionally null on any bar whose lagged EMA is exactly zero.

Errors#

  • When parameters.period is not an integer >= 2 — throws Error
  • When parameters.roc_period is not an integer >= 1 — throws Error
  • When a bar is missing open, high, low, close, or volume, or one of them is not a finite number — throws Error

Complexity: time O(n), space O(n).

Worked example#

executed Captured by running this function on the input its own test provides. Real output of real code — but not asserted against a published figure.

Input#

input
{
  "bars": [
    {
      "timestamp": "2024-01-02",
      "basis": "synthetic-unadjusted",
      "open": 100,
      "high": 101.45,
      "low": 98.695,
      "close": 100,
      "volume": 750000,
      "benchmark": 200
    },
    {
      "timestamp": "2024-01-03",
      "basis": "synthetic-unadjusted",
      "open": 101.49111452,
      "high": 103.38381693,
      "low": 100.05480022,
      "close": 101.78791214,
      "volume": 795117,
      "benchmark": 200.56326135
    },
    {
      "timestamp": "2024-01-04",
      "basis": "synthetic-unadjusted",
      "open": 102.45519048,
      "high": 104.6701838,
      "low": 100.91147007,
      "close": 102.9549389,
      "volume": 840234,
      "benchmark": 201.11020913
    }
  ],
  "parameters": {}
}

Call#

chaikinVolatility(input)

Returns#

object with 9 fields: topic_id, title, state, ready, ready_at, series, latest, parameters, …

{
  "topic_id": "D07-F06-A02",
  "title": "Chaikin Volatility",
  "state": "calculated",
  "ready": true,
  "ready_at": 23,
  "series": {
    "value": [null, null, null, null, null, null]
  },
  "latest": {
    "value": 11.096464053974685
  },
  "parameters": {},
  "diagnostics": {
    "causal": true,
    "input_count": 96
  }
}

Diagrams#

Chaikin Volatility — article hero
Chaikin Volatility — concept map
Chaikin Volatility — decision comparison
Chaikin Volatility — worked example

Calculation flow#

Chaikin Volatility calculation flow
flowchart LR
    A["ordered OHLC observations with session calendar, previous "] --> B["Validate order, basis, and finite values"]
    B --> C["Apply the selected Chaikin Volatility convention"]
    C --> D["Emit value, readiness, and diagnostics"]
    D --> E["Interpret descriptively; test outcomes separately"]
    B -->|invalid or insufficient| X["Withhold output with a reason"]
Chaikin Volatility readiness and evidence states
stateDiagram-v2
    [*] --> Waiting
    Waiting --> Ready: enough valid causal observations
    Waiting --> Rejected: malformed or unsupported input
    Ready --> Calculated: selected formula applied
    Calculated --> Interpreted: diagnostic and limitation retained
    Interpreted --> Ready: next observation arrives
    Rejected --> Waiting: corrected input and deterministic reset

How it works#

This page states the contract — how to call it correctly. The article explains the concept: why it works, and where it breaks.

Read the article →

References#

  • TA-Lib function groups — see linked primary or authoritative record
  • TA-Lib C/C++ API — see linked primary or authoritative record
  • TA-Lib maintained source — see linked primary or authoritative record
  • Evidence decision
  • Level 1 evidence map

The rest of the Range and Volatility Indicators family#