jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
041ff008de6fe892e8d9ac1e251eaa892cbdf97b
OpenBB/website/versioned_docs/version-v3/sdk/reference/ta/ma.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

3.1 KiB
Vendored
Raw Blame History

title, description
title description
ma OpenBB SDK Function

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

ma

Plots MA technical indicator

Source Code: [link]

openbb.ta.ma(data: pd.Series, window: List[int] = None, offset: int = 0, ma_type: str = "EMA", symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
data pd.Series Series of prices None False
window List[int] Length of EMA window None True
offset int Offset variable 0 True
ma_type str Type of moving average. Either "EMA" "ZLMA" or "SMA" EMA True
symbol str Ticker True
export str Format to export data 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

Examples

from openbb_terminal.sdk import openbb
df = openbb.stocks.load("AAPL")
openbb.ta.ma_chart(data=df["Adj Close"], symbol="AAPL", ma_type="EMA", window=[20, 50, 100])

from openbb_terminal.sdk import openbb
spuk_index = openbb.economy.index(indices = ["^SPUK"])
openbb.ta.ma_chart(data = spuk_index["^SPUK"], symbol = "S&P UK Index", ma_type = "EMA", window = [20, 50, 100])

Plots MA technical indicator

Source Code: [link]

openbb.ta.ma_chart(data: pd.Series, window: List[int] = None, offset: int = 0, ma_type: str = "EMA", symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
data pd.Series Series of prices None False
window List[int] Length of EMA window None True
offset int Offset variable 0 True
ma_type str Type of moving average. Either "EMA" "ZLMA" or "SMA" EMA True
symbol str Ticker True
export str Format to export data 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

Examples

from openbb_terminal.sdk import openbb
df = openbb.stocks.load("AAPL")
openbb.ta.ma_chart(data=df["Adj Close"], symbol="AAPL", ma_type="EMA", window=[20, 50, 100])

from openbb_terminal.sdk import openbb
spuk_index = openbb.economy.index(indices = ["^SPUK"])
openbb.ta.ma_chart(data = spuk_index["^SPUK"], symbol = "S&P UK Index", ma_type = "EMA", window = [20, 50, 100])