# Pivot Range Width

`D08-F01-A13` · Geometric Chart Patterns → Pivots and Levels · archetype `record-transform` · difficulty 2/5 · verification **verified**

Full page: https://docs.thefintechbuilder.com/geometric-chart-patterns/pivots-and-levels/pivot-range-width/
Agent skill: `npx skills add IslamBaraka90/Fintech-Algorithms-Library` — https://docs.thefintechbuilder.com/guides/agent-skill/

## Install and import

```bash
npm install fintech-algorithms
```

```ts
import { pivotRangeWidth } from "fintech-algorithms/geometric-chart-patterns/pivots-and-levels/pivot-range-width";
```

## Signature

```ts
pivotRangeWidth(input)
```

Measures the central pivot range rather than its bands: `bottom` is the previous bar's midpoint `(H + L) / 2`, `top` is that midpoint reflected through the pivot, and `width` is the absolute distance between them.

## Parameters

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `input` | `TopicInput` | yes | `bars` is the required OHLCV history, strictly ordered by `timestamp` and on a single adjustment basis. This topic reads no keys from `parameters`, though `period` (default `20`) is still validated as an integer of at least 2 if supplied. |

## Returns

`TopicResult`

`series` and `latest` carry `pivot`, `bottom`, `top` and `width` - note this variant emits no `r1`/`s1` keys. The warm-up is one bar, because all four values come from the preceding bar.

## Warm-up

The first `1 bar` positions are `null`. Index 0 is null across all four series; `ready_at` is 1 for any input of two or more bars.

## Errors

- When a bar's `high` is below its own `open`, `close`, or `low` (or `low` is above them) — throws Error
- When `period` is supplied as a non-integer or as a value below 2 — throws Error

## Complexity

Time `O(n)`, space `O(n)`.

## Worked example

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`:

```json
{
  "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

```ts
pivotRangeWidth(input)
```

### Returns

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

```json
{
  "topic_id": "D08-F01-A13",
  "title": "Pivot Range Width",
  "state": "calculated",
  "ready": true,
  "ready_at": 1,
  "series": {
    "pivot": [
      null,
      100.04833333333333,
      101.74217643000001,
      102.84553092333333,
      103.11026585,
      102.75204238333333
    ],
    "bottom": [
      null,
      100.07249999999999,
      101.719308575,
      102.790826935,
      103.04925743,
      102.71241351
    ],
    "top": [
      null,
      100.02416666666667,
      101.76504428500003,
      102.90023491166666,
      103.17127427000001,
      102.79167125666666
    ],
    "width": [
      null,
      0.048333333333317796,
      0.04573571000003085,
      0.10940797666665958,
      0.12201684000001478,
      0.07925774666665575
    ]
  },
  "latest": {
    "pivot": 101.55414906333333,
    "bottom": 101.59647065,
    "top": 101.51182747666665,
    "width": 0.08464317333334748
  },
  "parameters": {},
  "diagnostics": {
    "causal": true,
    "input_count": 96
  }
}
```

## Verification and provenance

Tier: **verified** (via E).

The worked example below is the figure published in this algorithm's article, replayed and asserted by the test suite on every build. The arithmetic cannot drift without the build failing.

Both tiers guarantee the signature. Full explanation: https://docs.thefintechbuilder.com/guides/verification/

Generated from the docs.json payload shipped inside fintech-algorithms@0.13.0.
The signature and parameter list are checked against the compiled implementation at build time,
so a description that contradicts the code fails the build rather than reaching this file.

## Links

- Article (how it works, step by step): https://thefintechbuilder.com/geometric-chart-patterns/pivots-and-levels/pivot-range-width/
- Implementation source: https://github.com/IslamBaraka90/Fintech-Algorithms-Library/blob/main/src/geometric-chart-patterns/pivots-and-levels/pivot-range-width/impl.ts
- Package on npm: https://www.npmjs.com/package/fintech-algorithms
- Domain index for agents: https://docs.thefintechbuilder.com/geometric-chart-patterns/llms.txt
