Files
OpenBB/website/content/sdk/reference/ta/demark.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

108 lines
2.5 KiB
Markdown
Vendored

---
title: demark
description: This page provides comprehensive documentation on the demark sequential
indicator feature offered. It includes detailed source codes, parameters, returns,
and examples for users to understand how to get integer values for demark sequential
indicators, and also how to plot these indicators.
keywords:
- demark sequential indicator
- technical analysis
- plot indicators
- OpenBB terminal
- OpenBB finance
- GitHub link
- OpenBB stocks
- matplotlib.axes
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="ta.demark - Reference | OpenBB SDK Docs" />
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<Tabs>
<TabItem value="model" label="Model" default>
Get the integer value for demark sequential indicator
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L257)]
```python
openbb.ta.demark(values: pd.Series)
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| values | pd.Series | Series of close values | None | False |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DataFrame | Dataframe of UP and DOWN sequential indicators |
---
## Examples
```python
from openbb_terminal.sdk import openbb
df = openbb.stocks.load("AAPL")
openbb.ta.demark(df["Close"])
```
---
</TabItem>
<TabItem value="view" label="Chart">
Plot demark sequential indicator
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L644)]
```python
openbb.ta.demark_chart(data: pd.DataFrame, symbol: str = "", min_to_show: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| data | pd.DataFrame | DataFrame of values | None | False |
| symbol | str | Symbol that the data corresponds to | | True |
| min_to_show | int | Minimum value to show | 5 | True |
| export | str | Format to export data | | True |
| external_axes | Optional[List[plt.Axes]] | External axes (1 axes are 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.demark_chart(df)
```
---
</TabItem>
</Tabs>