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

47 lines
1.4 KiB
Markdown
Vendored

---
title: chart
description: Extend your technical analysis with the OpenBB crypto chart function.
This feature allows loading of cryptocurrency data, optional title configuration
based on Coin and Currency, and control over plot scale (linear or log). Source
code is available.
keywords:
- Technical Analysis
- OpenBB crypto chart
- Cryptocurrency data
- matplotlib axes
- linear plot scale
- log plot scale
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="crypto.chart - Reference | OpenBB SDK Docs" />
Load data for Technical Analysis
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/cryptocurrency_helpers.py#L747)]
```python
openbb.crypto.chart(prices_df: pd.DataFrame, to_symbol: str = "", from_symbol: str = "", source: str = "", exchange: str = "", interval: str = "", external_axes: Optional[list[matplotlib.axes._axes.Axes]] = None, yscale: str = "linear")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| prices_df | pd.DataFrame | Cryptocurrency | None | False |
| to_symbol | str | Coin (only used for chart title), by default "" | | True |
| from_symbol | str | Currency (only used for chart title), by default "" | | True |
| yscale | str | Scale for y axis of plot Either linear or log | linear | True |
---
## Returns
This function does not return anything
---