mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* 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>
129 lines
3.6 KiB
Markdown
Vendored
129 lines
3.6 KiB
Markdown
Vendored
---
|
|
title: ma
|
|
description: Comprehensive guide to the ma and ma_chart functions as part of the OpenBB
|
|
technical analysis python package. These functions focus on plotting the moving
|
|
average (MA) technical indicator of various types like EMA, ZLMA and SMA for a given
|
|
time-series data.
|
|
keywords:
|
|
- Technical Analysis
|
|
- Moving Average
|
|
- EMA
|
|
- SMA
|
|
- ZLMA
|
|
- Pandas
|
|
- Financial Data
|
|
- Data Visualization
|
|
- FAANG stocks
|
|
- MA Chart
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="ta.ma - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Plots MA technical indicator
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_view.py#L32)]
|
|
|
|
```python
|
|
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
|
|
|
|
```python
|
|
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])
|
|
```
|
|
|
|
```python
|
|
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])
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Plots MA technical indicator
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_view.py#L32)]
|
|
|
|
```python
|
|
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
|
|
|
|
```python
|
|
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])
|
|
```
|
|
|
|
```python
|
|
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])
|
|
```
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|