Files
OpenBB/website/content/sdk/reference/ta/bbands.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.5 KiB
Vendored

title, description, keywords
title description keywords
bbands This documentation is about the 'bbands' function in the OpenBB finance library. It allows users to calculate and plot Bollinger Bands for financial data, providing multiple parameters for customization.
OpenBB finance library
Bollinger Bands
Financial data analysis
Python financial tools
Technical analysis
Volatility models
Financial chart plotting

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

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

Calculate Bollinger Bands

Source Code: [link]

openbb.ta.bbands(data: pd.DataFrame, window: int = 15, n_std: float = 2, mamode: str = "ema")

Parameters

Name Type Description Default Optional
data pd.DataFrame Dataframe of ohlc prices None False
window int Length of window to calculate BB 15 True
n_std float Number of standard deviations to show 2 True
mamode str Method of calculating average ema True

Returns

Type Description
pd.DataFrame Dataframe of bollinger band data

Plots bollinger bands

Source Code: [link]

openbb.ta.bbands_chart(data: pd.DataFrame, symbol: str = "", window: int = 15, n_std: float = 2, mamode: str = "sma", 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
symbol str Ticker symbol True
window int Length of window to calculate BB 15 True
n_std float Number of standard deviations to show 2 True
mamode str Method of calculating average sma True
export str Format of export file True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything