Files
OpenBB/website/content/sdk/reference/stocks/load.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

2.1 KiB
Vendored

title, description, keywords
title description keywords
load Learn how to use the load function within OpenBBTerminal's stocks module to retrieve and analyze data. Provide a symbol (ticker), define start and end dates, interval, choose whether to include pre/post-hours data and the data source. Options to retrieve weekly and monthly data are available. The gathered data is returned as a pandas DataFrame.
symbol analysis
start_date
interval
end_date
prepost
source
YahooFinance
weekly data
monthly data
verbose
data extraction
dataframe

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

Load a symbol to perform analysis using the string above as a template.

Source Code: [link]

openbb.stocks.load(symbol: 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, verbose: bool = True)

Parameters

Name Type Description Default Optional
symbol str Ticker to get data None False
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
verbose bool Display verbose information on what was the symbol that was loaded True True

Returns

Type Description
pd.DataFrame Dataframe of data