Futures Curve
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FuturesCurve | FuturesCurveQueryParams | FuturesCurveData |
Import Statement
from openbb_core.provider.standard_models.futures_curve import (
FuturesCurveData,
FuturesCurveQueryParams,
)
Parameters
- standard
- cboe
- deribit
- yfinance
symbol: str
Symbol to get data for.
date: Union[date | str, list[date | str]]
A specific date to get data for. Multiple items allowed for provider(s): cboe, yfinance.
symbol: Literal['VX_AM', 'VX_EOD']
Default: VX_EOD
Description
Symbol to get data for.Default is 'VX_EOD'. Entered dates return the data nearest to the entered date.
'VX_AM' = Mid-Morning TWAP Levels
'VX_EOD' = 4PM Eastern Time Levels
date: Union[date | str, list[date | str]]
A specific date to get data for. Multiple items allowed for provider(s): cboe, yfinance.
symbol: Literal['BTC', 'ETH', 'PAXG']
Default: BTC
Symbol to get data for. Default is 'btc' Supported symbols are: ['btc', 'eth', 'paxg']
date: Union[date | str, list[date | str]]
A specific date to get data for. Multiple items allowed for provider(s): cboe, yfinance.
hours_ago: Union[Union[int, list[int], str], list[Union[int, list[int], str]]]
Compare the current curve with the specified number of hours ago. Default is None. Multiple items allowed for provider(s): deribit.
symbol: str
Symbol to get data for.
date: Union[date | str, list[date | str]]
A specific date to get data for. Multiple items allowed for provider(s): cboe, yfinance.
Data
- standard
- cboe
- deribit
- yfinance
date: date | str
The date of the data.
expiration: str
Futures expiration month.
price: float
The price of the futures contract.
date: date | str
The date of the data.
expiration: str
Futures expiration month.
price: float
The price of the futures contract.
symbol: str
Symbol representing the entity requested in the data.
date: date | str
The date of the data.
expiration: str
Futures expiration month.
price: float
The price of the futures contract.
hours_ago: int
The number of hours ago represented by the price. Only available when hours_ago is set in the query.
date: date | str
The date of the data.
expiration: str
Futures expiration month.
price: float
The price of the futures contract.