Skip to main content

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

NameTypeDescriptionDefaultOptional
datapd.DataFrameLoaded fx historical dataNoneFalse
to_symbolstrTo forex symbolTrue
from_symbolstrFrom forex symbolTrue
maOptional[Iterable[int]]Moving averagesNoneTrue
external_axesOptional[List[plt.Axes]]External axes (1 axis is expected in the list), by default NoneNoneTrue

Returns

This function does not return anything