mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
90 lines
2.4 KiB
Markdown
Vendored
90 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: atr
|
|
description: This page provides detailed documentation on the Average True Range (ATR)
|
|
feature in the OpenBB terminal. It includes descriptions and code examples for both
|
|
the volatility model and view, with an emphasis on working with OHLC price dataframes.
|
|
The page also hosts links to the source code on GitHub.
|
|
keywords:
|
|
- ATR
|
|
- Average True Range
|
|
- Technical Analysis
|
|
- Volatility Model
|
|
- Volatility View
|
|
- OHLC Prices
|
|
- Documentation
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="ta.atr - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Average True Range
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_model.py#L132)]
|
|
|
|
```python
|
|
openbb.ta.atr(data: pd.DataFrame, window: int = 14, mamode: str = "ema", offset: int = 0)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | Dataframe of ohlc prices | None | False |
|
|
| window | int | Length of window | 14 | True |
|
|
| mamode | str | Type of filter | ema | True |
|
|
| offset | int | Offset value | 0 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dataframe of atr |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Plots ATR
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_view.py#L289)]
|
|
|
|
```python
|
|
openbb.ta.atr_chart(data: pd.DataFrame, symbol: str = "", window: int = 14, mamode: str = "sma", offset: int = 0, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | Dataframe of ohlc prices | None | False |
|
|
| symbol | str | Ticker symbol | | True |
|
|
| window | int | Length of window to calculate upper channel | 14 | True |
|
|
| export | str | Format of export file | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|