Deribit Instruments
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
DeribitInstruments | DeribitInstrumentsQueryParams | DeribitInstrumentsData |
Import Statement
from openbb_core.provider.standard_models. import (
DeribitInstrumentsData,
DeribitInstrumentsQueryParams,
)
Parameters
- standard
- deribit
symbol: str | None | list[str | None]
One or more instrument names. When given, the currency and kind are ignored. Multiple items allowed.
currency: str | None
Default: any
The settlement currency of the instruments.
kind: str | None
The kind of instrument. Default is all of them.
expired: bool | None
Default: False
When True, returns instruments that have already expired.
Data
- standard
- deribit
symbol: str
The name of the instrument.
instrument_id: int | None
The numeric identifier of the instrument.
kind: str | None
The kind of instrument.
instrument_type: str | None
Whether the instrument is linear or reversed.
future_type: str | None
Whether the future is linear or reversed.
state: str | None
Whether the instrument's book is open.
base_currency: str | None
The currency the instrument is based on.
quote_currency: str | None
The currency the instrument is quoted in.
counter_currency: str | None
The counter currency of the instrument.
settlement_currency: str | None
The currency the instrument settles in.
settlement_period: str | None
How often the instrument settles.
underlying_type: str | None
The asset class of the underlying.
product_group: str | None
The margin group the instrument belongs to.
price_index: str | None
The index the instrument is priced against.
lot_size: int | None
The number of contracts in one lot.
min_trade_amount: float | None
The smallest amount that can be traded.
tick_size: float | None
The smallest price increment.
max_leverage: int | None
The highest leverage the instrument allows.
max_non_default_leverage: float | None
The highest leverage available outside the default tier.
max_liquidation_commission: float | None
The largest commission a liquidation is charged.
maker_commission: float | None
The commission charged to a resting order.
taker_commission: float | None
The commission charged to an aggressing order.
block_trade_commission: float | None
The commission charged to a block trade.
block_trade_min_trade_amount: float | None
The smallest amount a block trade can be.
block_trade_tick_size: float | None
The smallest price increment of a block trade.
option_type: str | None
Whether the option is a call or a put.
strike: float | None
The strike price of the option.
is_active: bool | None
Whether the instrument can be traded right now.
contract_size: float | None
The size of one contract.
is_csr: bool | None
Whether the instrument is a cross settled routed pair.
is_cbe_routed: bool | None
Whether the instrument routes to Coinbase Exchange liquidity.
index_id: int | None
The numeric identifier of the price index.
tick_size_steps: list[dict] | None
The price levels above which a different tick size applies.
base_currency_uuid: str | None
The unique identifier of the base currency.
quote_currency_uuid: str | None
The unique identifier of the quote currency.
creation_timestamp: datetime | None
When the instrument was listed.
expiration_timestamp: datetime | None
When the instrument expires. Perpetual and spot instruments carry none.