Futures Historical
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FuturesHistorical | FuturesHistoricalQueryParams | FuturesHistoricalData |
Import Statement
from openbb_core.provider.standard_models.futures_historical import (
FuturesHistoricalData,
FuturesHistoricalQueryParams,
)
Parameters
- standard
- deribit
- yfinance
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): deribit, yfinance.
• Optional: False
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
expiration: str
Future expiry date with format YYYY-MM
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): deribit, yfinance.
• Optional: False
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
expiration: str
Future expiry date with format YYYY-MM
• Optional: True
interval: Literal['1m', '3m', '5m', '10m', '15m', '30m', '1h', '2h', '3h', '6h', '12h', '1d']
Time interval of the data to return.
• Default: 1d
• Optional: True
symbol: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): deribit, yfinance.
• Optional: False
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
expiration: str
Future expiry date with format YYYY-MM
• Optional: True
interval: Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q']
Time interval of the data to return.
• Default: 1d
• Optional: True
Data
- standard
- deribit
- yfinance
date: Union[datetime, str]
The date of the data.
open: float
The open price.
high: float
The high price.
low: float
The low price.
close: float
The close price.
volume: float
The trading volume.
date: Union[datetime, str]
The date of the data.
open: float
The open price.
high: float
The high price.
low: float
The low price.
close: float
The close price.
volume: float
The trading volume.
volume_notional: float
Trading volume in quote currency.
date: Union[datetime, str]
The date of the data.
open: float
The open price.
high: float
The high price.
low: float
The low price.
close: float
The close price.
volume: float
The trading volume.