index
Get the Deribit DVOL volatility index, as candles over a span.
Examples
from openbb import obb
# The BTC volatility index over the last month.
obb.deribit.volatility.index(currency='BTC', provider='deribit')
# Daily candles over a named span.
obb.deribit.volatility.index(currency='ETH', interval='1d', start_date='2026-01-01', end_date='2026-06-30', provider='deribit')
Parameters
- standard
- deribit
currency: str | None | list[str | None]
Default: BTC
The currency whose volatility index to read. Multiple items allowed.
start_date: Any | None | str
Return candles from this date onwards.
end_date: Any | None | str
Return candles up to this date.
interval: str | None
Default: 1d
Time interval of the data to return.
Returns
results: DeribitVolatilityIndex
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- deribit
date: datetime | str
When the candle closed.
currency: str
The currency the index belongs to.
open: float
The level the candle opened at.
high: float
The highest level of the candle.
low: float
The lowest level of the candle.
close: float
The level the candle closed at.