mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 16:32:10 +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>
48 lines
1.5 KiB
Markdown
Vendored
48 lines
1.5 KiB
Markdown
Vendored
---
|
|
title: kc
|
|
description: This documentation page provides detailed information about Keltner Channels,
|
|
a volatility-based band applied onto an asset's price. These channels aid in trend
|
|
determination by employing average true range (ATR) or volatility. The page also
|
|
provides comprehensive instructions about how to use and parameterize the 'kc' tool.
|
|
keywords:
|
|
- Keltner Channels
|
|
- volatility-based bands
|
|
- average true range
|
|
- ATR
|
|
- trend determination
|
|
- kc
|
|
- kc parameters
|
|
- n_length
|
|
- n_scalar
|
|
- s_mamode
|
|
- n_offset
|
|
- kc usage
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="etf/ta/kc - Reference | OpenBB Terminal Docs" />
|
|
|
|
Keltner Channels are volatility-based bands that are placed on either side of an asset's price and can aid in determining the direction of a trend.The Keltner channel uses the average true range (ATR) or volatility, with breaks above or below the top and bottom barriers signaling a continuation.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
kc [-l N_LENGTH] [-s N_SCALAR] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| n_length | Window length | 20 | True | None |
|
|
| n_scalar | scalar | 2 | True | None |
|
|
| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma |
|
|
| n_offset | offset | 0 | True | None |
|
|
|
|
|
|
|
|
---
|