Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/ta/kc.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

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