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

Add historical futures docstring

Browse Source
This commit is contained in:
James Maslek
2023-08-07 15:37:08 -04:00
parent fcde988335
commit be96f3bba7
1 changed files with 23 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
openbb_terminal/futures/sdk_helper.py
View File

@@ -16,7 +16,29 @@ def get_historical(
source: Optional[str] = "YahooFinance",
expiry: Optional[str] = "",
) -> pd.DataFrame:
"""Get historical futures data"""
"""Get historical futures data
Parameters
----------
symbols : Union[str, List[str]]
The futures symbols you want to retrieve historical data for.
It can be either a single symbol as a string or a list of symbols.
start_date : str
The start date of the historical data you want to retrieve. The date should be in the format "YYYY-MM-DD".
end_date : str
The end date of the historical data you want to retrieve. The date should be in the format "YYYY-MM-DD".
source : Optional[str], default "YahooFinance"
The source from which you want to retrieve the historical data. This parameter is optional and defaults to "YahooFinance".
Valid values for the source are "YahooFinance" and "DataBento".
expiry : Optional[str], default ""
The expiry date for futures contracts. This parameter is optional and defaults to an empty string.
It is applicable only when the source is "YahooFinance" and the symbols are futures contracts.
Returns
-------
pd.DataFrame
A pandas DataFrame containing the historical data for the given symbols and date range.
"""
if source == "YahooFinance":
if isinstance(symbols, str):
symbols = [symbols]