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

Average Directional Index Rating (ADXR)

Install and import#

bash
npm install fintech-algorithms
ts
import { averageDirectionalIndexRatingAdxr } from "fintech-algorithms/technical-indicators/trend-systems/average-directional-index-rating-adxr";

Signature#

averageDirectionalIndexRatingAdxr(input)

Runs the Wilder directional-movement system over the bars and returns the smoothed plus_di, minus_di and adx lines together with adxr, the average of the current adx and the adx from period bars earlier.

Parameters#

NameTypeNotes
inputTopicInputbars is the OHLCV series, validated for finite prices, strictly increasing timestamp, a single adjustment basis, non-negative volume, and a high and low that bracket the other prices. From parameters this topic reads only period (integer, minimum 2, default 14), which drives the Wilder smoothing of true range and directional movement and also sets the ADXR lookback.

Returns#

TopicResult

series and latest carry plus_di, minus_di, adx and adxr. Each line has its own warm-up, so the four do not start on the same bar.

Warm-up#

The first period bars (14 by default) positions are null. With the default period every series is null through index 13. plus_di and minus_di first resolve at index 14, so ready_at is 14; adx starts at index 27 and adxr at index 41, and both stay null until then.

Errors#

  • When parameters.period is present but is not an integer of at least 2 — throws Error
  • When bars is empty, or a bar has a non-finite price, a negative volume, a timestamp not greater than the previous one, or a high below its open, low, 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#

averageDirectionalIndexRatingAdxr(input)

Returns#

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

{
  "topic_id": "D07-F02-A09",
  "title": "Average Directional Index Rating (ADXR)",
  "state": "calculated",
  "ready": true,
  "ready_at": 14,
  "series": {
    "plus_di": [null, null, null, null, null, null],
    "minus_di": [null, null, null, null, null, null],
    "adx": [null, null, null, null, null, null],
    "adxr": [null, null, null, null, null, null]
  },
  "latest": {
    "plus_di": 7.883000058107942,
    "minus_di": 17.582637107405173,
    "adx": 21.37786648985954,
    "adxr": 21.42643518653003
  },
  "parameters": {},
  "diagnostics": {
    "causal": true,
    "input_count": 96
  }
}

Diagrams#

Average Directional Index Rating (ADXR) — article hero
Average Directional Index Rating (ADXR) — concept map
Average Directional Index Rating (ADXR) — decision comparison
Average Directional Index Rating (ADXR) — worked example

Calculation flow#

Average Directional Index Rating (ADXR) calculation flow
flowchart LR
    A["ordered OHLC or close observations with explicit window, s"] --> B["Validate order, basis, and finite values"]
    B --> C["Apply the selected Average Directional Index Rating (ADXR) 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"]
Average Directional Index Rating (ADXR) 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 Trend Systems family#