Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/ta/cci.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

1.9 KiB
Vendored

title, description
title description
cci OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

cci

Commodity channel index

Source Code: [link]

openbb.ta.cci(data: pd.DataFrame, window: int = 14, scalar: float = 0.0015)

Parameters

Name Type Description Default Optional
high_vals pd.Series High values None True
low_values pd.Series Low values None True
close-values pd.Series Close values None True
window int Length of window 14 True
scalar float Scalar variable 0.0015 True

Returns

Type Description
pd.DataFrame Dataframe of technical indicator

Plots CCI Indicator

Source Code: [link]

openbb.ta.cci_chart(data: pd.DataFrame, window: int = 14, scalar: float = 0.0015, 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 None False
window int Length of window 14 True
scalar float Scalar variable 0.0015 True
symbol str Stock ticker 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