jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/load.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.6 KiB
Vendored
Raw Blame History

title, description
title description
load OpenBB SDK Function

load

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", iexrange: str = "ytd", 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
iexrange str Timeframe to get IEX data. ytd 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