jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 23:12:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9a9cc14ec145f4133e69a389f8a032e35fee2ea3
OpenBB/website/versioned_docs/version-v3/sdk/reference/forex/candle.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.0 KiB
Vendored
Raw Blame History

title, description
title description
candle OpenBB SDK Function

candle

Show candle plot for fx data.

Source Code: [link]

openbb.forex.candle(data: pd.DataFrame, to_symbol: str = "", from_symbol: str = "", ma: Optional[Iterable[int]] = None, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, use_matplotlib: bool = True, add_trend: bool = False, yscale: str = "linear")

Parameters

Name Type Description Default Optional
data pd.DataFrame Loaded fx historical data None False
to_symbol str To forex symbol True
from_symbol str From forex symbol True
ma Optional[Iterable[int]] Moving averages None True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything