historical
Historical Index Levels.
Examples
from openbb import obb
obb.index.price.historical(symbol='^GSPC')
# Not all providers have the same symbols.
obb.index.price.historical(symbol='SPX')
Parameters
- standard
- cboe
- fmp
- intrinio
- yfinance
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, yfinance.
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, fmp, intrinio, yfinance.
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: Literal['1m', '1d'] | 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.
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.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, yfinance.
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: Literal['1m', '5m', '1h', '1d'] | None
Default: 1d
Time interval of the data to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, yfinance.
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.
limit: int | None
Default: 10000
The number of data entries to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): cboe, fmp, intrinio, yfinance.
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: Literal['1m', '2m', '5m', '15m', '30m', '60m', '90m', '1h', '1d', '5d', '1W', '1M', '1Q'] | None
Default: 1d
Time interval of the data to return.
Returns
results: IndexHistorical
Serializable results.
provider: Optional[Literal['cboe', 'fmp', 'intrinio', 'yfinance']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- cboe
- fmp
- intrinio
- yfinance
symbol: str | None
Symbol representing the entity requested in the data.
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | float | None
The trading volume.
symbol: str | None
Symbol representing the entity requested in the data.
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | float | None
The trading volume.
calls_volume: float | None
Number of calls traded during the most recent trading period. Only valid if interval is 1m.
puts_volume: float | None
Number of puts traded during the most recent trading period. Only valid if interval is 1m.
total_options_volume: float | None
Total number of options traded during the most recent trading period. Only valid if interval is 1m.
symbol: str | None
Symbol representing the entity requested in the data.
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | float | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.
change: float | None
Change in the price from the previous close.
change_percent: float | None
Change in the price from the previous close, as a normalized percent.
symbol: str | None
Symbol representing the entity requested in the data.
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | float | None
The trading volume.
symbol: str | None
Symbol representing the entity requested in the data.
date: date | datetime | str
The date of the data.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | float | None
The trading volume.