historical
Get historical price data for cryptocurrency pair(s) within a provider.
Examples
from openbb import obb
obb.crypto.price.historical(symbol='BTCUSD', provider='fmp')
obb.crypto.price.historical(symbol='BTCUSD', start_date='2024-01-01', end_date='2024-01-31', provider='fmp')
obb.crypto.price.historical(symbol='BTCUSD,ETHUSD', start_date='2024-01-01', end_date='2024-01-31', provider='polygon')
# Get monthly historical prices from Yahoo Finance for Ethereum.
obb.crypto.price.historical(symbol='ETH-USD', interval=1m, start_date='2024-01-01', end_date='2024-12-31', provider='yfinance')
Parameters
- standard
- fmp
- polygon
- tiingo
- yfinance
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | 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): fmp, polygon, tiingo, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
interval: Literal['1m', '5m', '1h', '1d']
Default: 1d
Time interval of the data to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
interval: str
Default: 1d
Time interval of the data to return. The numeric portion of the interval can be any positive integer. The letter portion can be one of the following: s, m, h, d, W, M, Q, Y
sort: Literal['asc', 'desc']
Default: asc
Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date.
limit: int
Default: 49999
The number of data entries to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
interval: Union[Literal['1m', '5m', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '7d', '30d'], str]
Default: 1d
Time interval of the data to return.
exchanges: Union[Union[list[str], str], list[Union[list[str], str]]]
To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple items allowed for provider(s): tiingo.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | 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']
Default: 1d
Time interval of the data to return.
Returns
results: list[CryptoHistorical]
Serializable results.
provider: Optional[Literal['fmp', 'polygon', 'tiingo', 'yfinance']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- fmp
- polygon
- tiingo
- yfinance
date: Union[Union[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
The trading volume.
vwap: float
Volume Weighted Average Price over the period.
date: Union[Union[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
The trading volume.
vwap: float
Volume Weighted Average Price over the period.
change: float
Change in the price from the previous close.
change_percent: float
Change in the price from the previous close, as a normalized percent.
date: Union[Union[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
The trading volume.
vwap: float
Volume Weighted Average Price over the period.
transactions: Annotated[int, Gt(gt=0)]
Number of transactions for the symbol in the time period.
date: Union[Union[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
The trading volume.
vwap: float
Volume Weighted Average Price over the period.
transactions: int
Number of transactions for the symbol in the time period.
volume_notional: float
The last size done for the asset on the specific date in the quote currency. The volume of the asset on the specific date in the quote currency.
date: Union[Union[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
The trading volume.
vwap: float
Volume Weighted Average Price over the period.