Index Historical

---

Implementation details

Class names

Model name	Parameters class	Data class
IndexHistorical	IndexHistoricalQueryParams	IndexHistoricalData

Import Statement

from openbb_core.provider.standard_models.index_historical import (
IndexHistoricalData,
IndexHistoricalQueryParams,
)

---

Parameters

• standard
• cboe
• fmp
• intrinio
• polygon
• yfinance

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): cboe, intrinio, polygon, yfinance.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
interval	str	Time interval of the data to return.	1d	True
limit	int	The number of data entries to return.	10000	True
sort	Literal['asc', 'desc']	Sort the data in ascending or descending order.	asc	True
provider	Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): cboe, intrinio, polygon, yfinance.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
interval	str	Time interval of the data to return.	1d	True
limit	int	The number of data entries to return.	10000	True
sort	Literal['asc', 'desc']	Sort the data in ascending or descending order.	asc	True
provider	Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True
use_cache	bool	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.	True	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): cboe, intrinio, polygon, yfinance.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
interval	str	Time interval of the data to return.	1d	True
limit	int	The number of data entries to return.	10000	True
sort	Literal['asc', 'desc']	Sort the data in ascending or descending order.	asc	True
provider	Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True
timeseries	int	Number of days to look back.	None	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): cboe, intrinio, polygon, yfinance.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
interval	str	Time interval of the data to return.	1d	True
limit	int	The number of data entries to return.	10000	True
sort	Literal['asc', 'desc']	Sort the data in ascending or descending order.	asc	True
provider	Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): cboe, intrinio, polygon, yfinance.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
interval	str	Time interval of the data to return.	1d	True
limit	int	The number of data entries to return.	10000	True
sort	Literal['asc', 'desc']	Sort the data in ascending or descending order.	asc	True
provider	Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for. Multiple items allowed for provider(s): cboe, intrinio, polygon, yfinance.		False
start_date	Union[str, date]	Start date of the data, in YYYY-MM-DD format.	None	True
end_date	Union[str, date]	End date of the data, in YYYY-MM-DD format.	None	True
interval	str	Time interval of the data to return.	1d	True
limit	int	The number of data entries to return.	10000	True
sort	Literal['asc', 'desc']	Sort the data in ascending or descending order.	asc	True
provider	Literal['cboe', 'fmp', 'intrinio', 'polygon', 'yfinance']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	cboe	True
period	Literal['1d', '5d', '1mo', '3mo', '6mo', '1y', '2y', '5y', '10y', 'ytd', 'max']	Time period of the data to return.	max	True
prepost	bool	Include Pre and Post market data.	True	True
rounding	bool	Round prices to two decimals?	True	True

---

Data

• standard
• cboe
• fmp
• intrinio
• polygon
• yfinance

Name	Type	Description
date	Union[date, datetime]	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	int	The trading volume.

Name	Type	Description
date	Union[date, datetime]	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	int	The trading volume.
calls_volume	float	Number of calls traded during the most recent trading period. Only valid if interval is 1m.
puts_volume	float	Number of puts traded during the most recent trading period. Only valid if interval is 1m.
total_options_volume	float	Total number of options traded during the most recent trading period. Only valid if interval is 1m.

Name	Type	Description
date	Union[date, datetime]	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	int	The trading volume.
adj_close	float	The adjusted close price.
unadjusted_volume	float	Unadjusted volume of the symbol.
change	float	Change in the price of the symbol from the previous day.
change_percent	float	Change % in the price of the symbol.
label	str	Human readable format of the date.
change_over_time	float	Change % in the price of the symbol over a period of time.

Name	Type	Description
date	Union[date, datetime]	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	int	The trading volume.

Name	Type	Description
date	Union[date, datetime]	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	int	The trading volume.
transactions	int	Number of transactions for the symbol in the time period.

Name	Type	Description
date	Union[date, datetime]	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	int	The trading volume.