jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-07 01:41:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e7abffee64aec08ab29107534b4e2fe49d2fe552
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/candles.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02: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: 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