jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-05 08:51:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c57fb71c5bc1032dfd4ef4f3edfc74afa8c0a2e
OpenBB/website/content/terminal/reference/forex/candle.md
jose-donato e1962252ad Docs fixes (#3530) 
* fix(docs): added margin between sections

* fix: images

* readd old content for examples/images

* fix: codespell

* fix: codespell

* fix: ga

* fix: remove temp lorem ipsum

* fix: docu config for edit page

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 14:56:17 -05:00

1.1 KiB
Vendored
Raw Blame History

title, description
title description
candle OpenBB Terminal Function

candle

Show candle for loaded fx data

Usage

usage: candle [-p] [--sort {adjclose,open,close,high,low,volume,logret}] [-r] [--raw] [-t] [--ma MOV_AVG] [--log]

Parameters

Name Description Default Optional Choices
plotly Flag to show interactive plotly chart True True None
sort Choose a column to sort by. Only works when raw data is displayed. True adjclose, open, close, high, low, volume, logret
reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. False True None
raw Shows raw data instead of chart. False True None
trendlines Flag to add high and low trends to candle False True None
mov_avg Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. None True None
logy Plot with y axis on log scale False True None