jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
948d2ef29900c48ec26616eb48ba952aaaadd883
OpenBB/website/content/sdk/reference/crypto/candles.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

1.6 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
candles 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.
crypto.candles
candle chart
Binance source
Python script
data visualization
OpenBB crypto module
matplotlib
OHLCV

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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