mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
* 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>
44 lines
1.0 KiB
Markdown
Vendored
44 lines
1.0 KiB
Markdown
Vendored
---
|
|
title: atr
|
|
description: This page provides comprehensive information about the Average True Range
|
|
(ATR) including its usage, implementation, and parameters. It serves as a key resource
|
|
for understanding ATR, a widely used tool for measuring volatility in market prices.
|
|
keywords:
|
|
- average true range
|
|
- volatility measure
|
|
- ATR usage
|
|
- ATR parameters
|
|
- ema
|
|
- sma
|
|
- wma
|
|
- hma
|
|
- zlma
|
|
- n_length
|
|
- s_mamode
|
|
- n_offset
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="etf/ta/atr - Reference | OpenBB Terminal Docs" />
|
|
|
|
Averge True Range is used to measure volatility, especially volatility caused by gaps or limit moves.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
atr [-l N_LENGTH] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| n_length | Window length | 14 | True | None |
|
|
| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma |
|
|
| n_offset | offset | 0 | True | None |
|
|
|
|
---
|