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

Relative Volume

Install and import#

bash
npm install fintech-algorithms
ts
import { relativeVolume } from "fintech-algorithms/technical-indicators/volume-indicators/relative-volume";

Signature#

relativeVolume(input)

Divides each bar's volume by the simple moving average of volume over the preceding window, giving a multiple of normal activity.

Parameters#

NameTypeNotes
inputTopicInputbars needs timestamp and volume. From parameters this topic reads period (default 14, an integer of at least 2).

Returns#

TopicResult

series holds a single value, the ratio of volume to its period average, and latest its last element. A window whose average volume is 0 yields null. The warm-up is the averaging window.

Warm-up#

The first `period` - 1 bars (13 with the default 14) positions are null. ready_at is 13 on default parameters. The window includes the current bar, so the reading is not a comparison against history alone.

Errors#

  • When period is not an integer of at least 2 — throws Error
  • When a bar carries a negative volume — throws Error
  • When bars is empty — 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#

relativeVolume(input)

Returns#

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

{
  "topic_id": "D07-F05-A17",
  "title": "Relative Volume",
  "state": "calculated",
  "ready": true,
  "ready_at": 13,
  "series": {
    "value": [null, null, null, null, null, null]
  },
  "latest": {
    "value": 1.0655386224508623
  },
  "parameters": {},
  "diagnostics": {
    "causal": true,
    "input_count": 96
  }
}

Diagrams#

Relative Volume — article hero
Relative Volume — concept map
Relative Volume — decision comparison
Relative Volume — worked example

Calculation flow#

Relative Volume calculation flow
flowchart LR
    A["basis-consistent OHLCV observations with venue/session cov"] --> B["Validate order, basis, and finite values"]
    B --> C["Apply the selected Relative Volume 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"]
Relative Volume 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 Volume Indicators family#