jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea393dcfa809d13388db88eee7e9326bfd809ecd
OpenBB/website/content/sdk/reference/etf/load.md
James Maslek 2a7ec56000 Sunset some dependencies (#4215) 
* Sunset some dependencies

* Mypy

* Last iex refs

* remove ref to investpy

* tests

---------

Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
2023-02-13 08:54:54 -05:00

1.5 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.etf.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