supertrend

Calculate the Supertrend ATR-banded trailing-stop overlay.

Examples

from openbb import obb
obb.technical.supertrend(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}], length=2)

Parameters

• standard

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

index: str
Default: date
Index column name in data, by default "date".

length: int
Default: 7
ATR lookback.

multiplier: float
Default: 3.0
ATR multiplier for the bands.

---

Returns

results: list[SupertrendData]

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
Observation date.

supertrend: float
Current trailing-stop value.

direction: int
1 when the trend is up, -1 when down. None during warm-up.

long_band: float
Long-side band — populated only when the trend is up.

short_band: float
Short-side band — populated only when the trend is down.