historical
Get historical price data for cryptocurrency pair(s) within a provider.
Examples
from openbb import obb
obb.crypto.price.historical(symbol='BTCUSD')
obb.crypto.price.historical(symbol='BTCUSD', start_date='2024-01-01', end_date='2024-01-31')
# 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')
Parameters
- standard
- fmp
- tiingo
- yfinance
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, tiingo, 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): fmp, tiingo, 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): fmp, tiingo, 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', '15m', '30m', '90m', '1h', '2h', '4h', '1d', '7d', '30d'] | None
Default: 1d
Time interval of the data to return.
exchanges: list[str] | str | None
To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX']
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, tiingo, 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: CryptoHistorical
Serializable results.
provider: Optional[Literal['fmp', '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
- tiingo
- yfinance
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
The close price.
volume: float | 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 | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float
The close price.
volume: 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.
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
The close price.
volume: float | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.
transactions: int | None
Number of transactions for the symbol in the time period.
volume_notional: float | None
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: 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
The close price.
volume: float | None
The trading volume.
vwap: float | None
Volume Weighted Average Price over the period.