mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
67 lines
2.9 KiB
Markdown
Vendored
67 lines
2.9 KiB
Markdown
Vendored
---
|
|
title: candle
|
|
description: This page provides a comprehensive guide on how to use the 'candle' function
|
|
in OpenBB Terminal. This function, primarily meant for stock evaluations, provides
|
|
a detailed candle plot of any given ticker. Features include adjustable parameters
|
|
for added customizability.
|
|
keywords:
|
|
- stock evaluation
|
|
- candle function
|
|
- candle plot
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="etf.candle - Reference | OpenBB SDK Docs" />
|
|
|
|
Show candle plot of loaded ticker.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L443)]
|
|
|
|
```python
|
|
openbb.etf.candle(symbol: str, data: pd.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = "", start_date: Union[datetime.datetime, str, NoneType] = None, interval: int = 1440, end_date: Union[datetime.datetime, str, NoneType] = None, prepost: bool = False, source: str = "YahooFinance", weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = "linear")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Ticker name | None | False |
|
|
| data | pd.DataFrame | Stock dataframe | None | True |
|
|
| use_matplotlib | bool | Flag to use matplotlib instead of interactive plotly chart | True | True |
|
|
| intraday | bool | Flag for intraday data for plotly range breaks | False | True |
|
|
| add_trend | bool | Flag to add high and low trends to chart | False | True |
|
|
| ma | Tuple[int] | Moving averages to add to the candle | None | True |
|
|
| asset_type_ | str | String to include in title | None | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True |
|
|
| asset_type_ | str | String to include in title | None | True |
|
|
| start_date | str or datetime | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True |
|
|
| interval | int | Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440 | 1440 | True |
|
|
| end_date | str or datetime | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True |
|
|
| prepost | bool | Pre and After hours data | False | True |
|
|
| source | str | Source of data extracted | YahooFinance | True |
|
|
| weekly | bool | Flag to get weekly data | False | True |
|
|
| monthly | bool | Flag to get monthly data | False | True |
|
|
| raw | bool | Flag to display raw data, by default False | False | True |
|
|
| yscale | str | Linear or log for yscale | linear | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.stocks.candle("AAPL")
|
|
```
|
|
|
|
---
|