breakouts

Detect channel breakouts where price closes beyond a rolling envelope.

Examples

from openbb import obb
obb.technical.signals.breakouts(data=[{'date': '2023-01-02', 'open': 110.0, 'high': 120.0, 'low': 100.0, 'close': 115.0, 'volume': 10000.0}, {'date': '2023-01-03', 'open': 165.0, 'high': 180.0, 'low': 150.0, 'close': 172.5, 'volume': 15000.0}, {'date': '2023-01-04', 'open': 146.67, 'high': 160.0, 'low': 133.33, 'close': 153.33, 'volume': 13333.33}, {'date': '2023-01-05', 'open': 137.5, 'high': 150.0, 'low': 125.0, 'close': 143.75, 'volume': 12500.0}, {'date': '2023-01-06', 'open': 132.0, 'high': 144.0, 'low': 120.0, 'close': 138.0, 'volume': 12000.0}], method='donchian', length=20)

Parameters

• standard

data: Data | DataFrame | Series | dict | list | list[DataFrame] | list[Data] | list[Series] | ndarray
Input OHLC price series.

index: str
Default: date
Index column name in data.

method: str
Default: donchian
Channel definition: Donchian (rolling high/low) or Bollinger (mean +/- band_std * stdev).

length: int
Default: 20
Lookback window for the channel.

band_std: float
Bollinger band multiplier. Ignored for donchian. None resolves to 2.0 when method='bollinger'.

---

Returns

results: list[BreakoutEvent]

Serializable results.

provider: str

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard

date: date | datetime | str
Bar on which the breakout occurred.

direction: str
Which band was crossed.

price: float
Close price on the breakout bar.

band: float
Previous bar's band level that was breached.

magnitude: float
Signed distance: price - band. Positive for upside, negative for downside.

bars_in_range: int
Bars since the most recent breakout (in either direction).