Cboe Equity Historical
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CboeEquityHistorical | CboeEquityHistoricalQueryParams | CboeEquityHistoricalData |
Import Statement
from openbb_core.provider.standard_models. import (
CboeEquityHistoricalData,
CboeEquityHistoricalQueryParams,
)
Parameters
- standard
- cboe
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): cboe.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): cboe.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
interval: str | None
Default: 1d
Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.
Choices
- 1m
- 1d
use_cache: bool | None
Default: True
When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass.
Data
- standard
- cboe
date: date | 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 | int | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.
date: date | 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 | int | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.
calls_volume: int | None
Number of calls traded during the most recent trading period. Only valid if interval is 1m.
puts_volume: int | None
Number of puts traded during the most recent trading period. Only valid if interval is 1m.
total_options_volume: int | None
Total number of options traded during the most recent trading period. Only valid if interval is 1m.