jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 00:42:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c57fb71c5bc1032dfd4ef4f3edfc74afa8c0a2e
OpenBB/website/content/sdk/reference/crypto/candles.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.1 KiB
Vendored
Raw Blame History

title, description
title description
candles OpenBB SDK Function

candles

Plot candle chart from dataframe. [Source: Binance]

Source Code: [link]

openbb.crypto.candles(candles_df: pd.DataFrame, volume: bool = True, ylabel: str = "", title: str = "", external_axes: list[matplotlib.axes._axes.Axes] | None = 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