Squeeze Momentum
Install and import#
npm install fintech-algorithmsimport { squeezeMomentum } from "fintech-algorithms/technical-indicators/bands-envelopes-and-squeezes/squeeze-momentum";Signature#
squeezeMomentum(input)Squeeze Momentum: the TTM squeeze flag and its two band pairs, plus a momentum line -- the regression slope of the close's distance from the midpoint of the period-bar high-low range.
Parameters#
| Name | Type | Notes |
|---|---|---|
input | TopicInput | bars 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 20, integer >= 2), used for the moving average, the standard deviation, the Keltner EMA, the ATR, the range extremes and the momentum regression, and multiplier (default 2, a finite number >= 0), applied to both band pairs. |
Returns#
TopicResult
series holds squeeze_on, bb_upper, bb_lower, kc_upper, kc_lower and momentum; latest carries the last of each. squeeze_on is a boolean and false is a real reading meaning no squeeze. The warm-ups differ: the flag and the four bands appear at period - 1 (19 at the default), which sets ready_at, while momentum needs a full window of those readings and first appears at 2 * period - 2 (38).
Warm-up#
The first `period - 1` bars for the bands and the flag, `2 * period - 2` bars for `momentum` (19 and 38 at the default period) positions are null. momentum regresses the close-minus-midpoint displacement over period bars, and that displacement is itself null until the range extremes fill, so it lags the rest of the payload by another period - 1 bars. The topic reports ready before momentum exists.
Errors#
- When
parameters.periodis not an integer >= 2 — throws Error - When
parameters.multiplieris not a finite number, or is negative — 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 * period),
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#
{
"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#
squeezeMomentum(input)Returns#
object with 9 fields: topic_id, title, state, ready, ready_at, series, latest, parameters, …
{
"topic_id": "D07-F07-A12",
"title": "Squeeze Momentum",
"state": "calculated",
"ready": true,
"ready_at": 19,
"series": {
"squeeze_on": [null, null, null, null, null, null],
"bb_upper": [null, null, null, null, null, null],
"bb_lower": [null, null, null, null, null, null],
"kc_upper": [null, null, null, null, null, null],
"kc_lower": [null, null, null, null, null, null],
"momentum": [null, null, null, null, null, null]
},
"latest": {
"squeeze_on": true,
"bb_upper": 108.52982269312228,
"bb_lower": 99.87127834687767,
"kc_upper": 110.40185024876313,
"kc_lower": 97.50750454809507,
"momentum": 0.0214809381766915
},
"parameters": {},
"diagnostics": {
"causal": true,
"input_count": 96
}
}Diagrams#
Calculation flow#
Squeeze Momentum calculation flow
flowchart LR
A["ordered OHLC or close observations, a declared centerline,"] --> B["Validate order, basis, and finite values"]
B --> C["Apply the selected Squeeze Momentum 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"]
Squeeze Momentum 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.
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