Average Price Transform
Install and import#
npm install fintech-algorithmsimport { averagePriceTransform } from "fintech-algorithms/technical-indicators/price-transforms/average-price-transform";Signature#
averagePriceTransform(input)Averages all four OHLC prices into one value per bar.
Parameters#
| Name | Type | Notes |
|---|---|---|
input | TopicInput | bars needs timestamp, open, high, low and close. This topic reads no keys from parameters, though parameters must still be an object when supplied. |
Returns#
TopicResult
series holds a single value, (open + high + low + close) / 4 for every bar, and latest its last element. Every bar produces a value, so there is no warm-up.
Warm-up#
The first none positions are not applicable. ready_at is 0. This is the same quantity Heikin-Ashi uses as its smoothed close.
Errors#
- When a bar's
open,high,loworcloseis not a finite number — throws Error - When a
lowis above the bar'sopen,highorclose— throws Error - When
barsis 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#
{
"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#
averagePriceTransform(input)Returns#
object with 9 fields: topic_id, title, state, ready, ready_at, series, latest, parameters, …
{
"topic_id": "D07-F08-A04",
"title": "Average Price Transform",
"state": "calculated",
"ready": true,
"ready_at": 0,
"series": {
"value": [
100.03625,
101.6794109525,
102.7479458125,
103.0046001225,
102.6675107225,
102.233242385
]
},
"latest": {
"value": 100.21300550000001
},
"parameters": {},
"diagnostics": {
"causal": true,
"input_count": 96
}
}Diagrams#
Calculation flow#
Average Price Transform calculation flow
flowchart LR
A["finite, basis-consistent OHLC observations and any require"] --> B["Validate order, basis, and finite values"]
B --> C["Apply the selected Average Price Transform 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 Price Transform 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