historical
Get the published level of a Deribit index over a span.
Examples
from openbb import obb
# The BTC index over the last day.
obb.deribit.index.historical(index_name='btc_usd', provider='deribit')
# The whole published history.
obb.deribit.index.historical(index_name='btc_usd', span='all', provider='deribit')
Parameters
- standard
- deribit
index_name: str | None | list[str | None]
Default: btc_usd
One or more index names, such as 'btc_usd'. Multiple items allowed.
span: str | None
Default: 1d
How far back the series runs.
Returns
results: DeribitIndexHistorical
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 level was published.
index_name: str
The name of the index.
price: float
The level of the index.