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

Awesome Oscillator

Install and import#

bash
npm install fintech-algorithms
ts
import { awesomeOscillator } from "fintech-algorithms/technical-indicators/momentum/awesome-oscillator";

Signature#

awesomeOscillator(input)

Subtracts a 34-period simple average of the median price from a 5-period one, measuring the gap between short and long swing momentum.

Parameters#

NameTypeNotes
inputTopicInputbars is a chronological array of OHLCV rows, each with a non-empty timestamp plus finite open, high, low, close and volume. This topic reads no keys from parameters: the median price is (high + low) / 2 and the 5 and 34 window lengths are fixed in the implementation. The shared momentum preamble still validates period (default 14), fast_period (default 5) and slow_period (default 34) before branching, so a bad value for any of them throws even though this topic reads none of them.

Returns#

TopicResult

series and latest carry one key, value, the 5-period simple average of the median price minus its 34-period simple average. The series opens with a null warm-up prefix set by the longer window.

Warm-up#

The first 33 bars positions are null. The 34-period average is the binding constraint, so the first non-null lands at index 33 and ready_at is 33 on the canonical fixture. The lengths are hard-coded, so this warm-up does not move with parameters.

Errors#

  • When period is supplied but is not an integer >= 2, even though this topic ignores it — throws Error
  • When a bar's low is above its open, high, or close — 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#

awesomeOscillator(input)

Returns#

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

{
  "topic_id": "D07-F03-A13",
  "title": "Awesome Oscillator",
  "state": "calculated",
  "ready": true,
  "ready_at": 33,
  "series": {
    "value": [null, null, null, null, null, null]
  },
  "latest": {
    "value": -2.700632041029408
  },
  "parameters": {},
  "diagnostics": {
    "causal": true,
    "input_count": 96
  }
}

Diagrams#

Awesome Oscillator — article hero
Awesome Oscillator — concept map
Awesome Oscillator — decision comparison
Awesome Oscillator — worked example

Calculation flow#

Awesome Oscillator calculation flow
flowchart LR
    A["an ordered price or OHLC series, declared lookbacks, smoot"] --> B["Validate order, basis, and finite values"]
    B --> C["Apply the selected Awesome Oscillator 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"]
Awesome Oscillator 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 Momentum family#