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>
50 lines
1.6 KiB
Markdown
Vendored
50 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: candles
|
|
description: The page provides documentation for the 'candles' function in the OpenBB
|
|
crypto module. It describes how a candle chart can be plotted from a provided DataFrame,
|
|
and the various parameters that can be adjusted.
|
|
keywords:
|
|
- crypto.candles
|
|
- candle chart
|
|
- Binance source
|
|
- Python script
|
|
- data visualization
|
|
- OpenBB crypto module
|
|
- matplotlib
|
|
- OHLCV
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.candles - Reference | OpenBB SDK Docs" />
|
|
|
|
Plot candle chart from dataframe. [Source: Binance]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/cryptocurrency_helpers.py#L799)]
|
|
|
|
```python
|
|
openbb.crypto.candles(candles_df: pd.DataFrame, volume: bool = True, ylabel: str = "", title: str = "", external_axes: Optional[list[matplotlib.axes._axes.Axes]] = None, yscale: str = "linear")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| candles_df | pd.DataFrame | Dataframe containing time and OHLCV | None | False |
|
|
| volume | bool | If volume data shall be plotted, by default True | True | True |
|
|
| ylabel | str | Y-label of the graph, by default "" | | True |
|
|
| title | str | Title of graph, by default "" | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
| yscale | str | Scaling for y axis. Either linear or log | linear | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|