jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 22:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
faa1e896fa66eda12edea8cd4e9df75ebbffd937
OpenBB/website/content/sdk/reference/ta/cci.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
cci This page provides information on the Commodity Channel Index (CCI) utility as part of the OpenBB platform. It comprises details about the technical model, related parameters, expected returns, and source code linked to Github. Also includes instructions for plotting CCI Indicator.
CCI
Commodity channel index
technical indicator
dataframe
Source code
Parameters
Returns

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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

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