settlements

Get the settlements, deliveries, and bankruptcies Deribit has processed.

Examples

from openbb import obb
# The most recent BTC settlements.
obb.deribit.market.settlements(currency='BTC', provider='deribit')
# Only the deliveries of one instrument.
obb.deribit.market.settlements(symbol='BTC-PERPETUAL', settlement_type='settlement', provider='deribit')

Parameters

• standard
• deribit

symbol: str | None | list[str | None]
One or more instrument names. When given, the currency is ignored. Multiple items allowed.

currency: str | None
Default: BTC
The settlement currency of the instruments.

settlement_type: str | None
The kind of settlement. Default is all of them.

start_date: Any | None | str
Search back no further than this date.

limit: int | None
Default: 100
The number of settlements to return, at most 1000.

---

Returns

results: DeribitSettlements

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

timestamp: datetime
When the instrument settled.

symbol: str | None
The name of the instrument.

settlement_type: str | None
Whether the event was a settlement or a delivery.

position: float | None
The size that settled.

index_price: float | None
The level of the index at settlement.

mark_price: float | None
The price the instrument settled at.

profit_loss: float | None
The profit and loss the settlement realized.

session_profit_loss: float | None
The profit and loss of the whole session.

funding: float | None
The funding the session paid.

session_bankruptcy: float | None
The loss the session could not cover.

session_tax: float | None
The socialised loss the session was charged.

session_tax_rate: float | None
The rate the socialised loss was charged at.

socialized: float | None
The loss spread across other accounts.