mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
2.0 KiB
Vendored
2.0 KiB
Vendored
title, description
| title | description |
|---|---|
| kc | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
kc
Keltner Channels
Source Code: [link]
openbb.ta.kc(data: pd.DataFrame, window: int = 20, scalar: float = 2, 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 | 20 | True |
| scalar | float | Scalar value | 2 | True |
| mamode | str | Type of filter | ema | True |
| offset | int | Offset value | 0 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe of rolling kc |
Plots Keltner Channels Indicator
Source Code: [link]
openbb.ta.kc_chart(data: pd.DataFrame, window: int = 20, scalar: float = 2, mamode: str = "ema", offset: int = 0, symbol: str = "", 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 |
| window | int | Length of window | 20 | True |
| scalar | float | Scalar value | 2 | True |
| mamode | str | Type of filter | ema | True |
| offset | int | Offset value | 0 | True |
| symbol | str | Ticker symbol | True | |
| export | str | Format to export data | True | |
| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True |
Returns
This function does not return anything