public/get_last_settlements_by_instrument

Retrieves historical settlement, delivery, and bankruptcy events for a specific instrument.

Settlement vs. delivery: Settlement is a daily event (at 08:00 UTC) for futures and perpetual positions that converts unrealized profit and loss into realized profit and loss. Option positions do not settle. Delivery is a one-time event that occurs when a futures or options contract expires — any remaining open position is closed at the delivery price. Delivery does not apply to perpetual or spot instruments. Both events take place at 08:00 UTC, which is why they are sometimes conflated.

Results can be filtered by settlement type and timestamp. Use pagination parameters (count and continuation) to retrieve large settlement histories. This method is useful for tracking settlement history for a specific instrument.

Note on profit_loss and session_profit_loss: Because this is a public endpoint, these fields are platform-wide aggregates, not per-account values. profit_loss is the sum of realized P&L of all position holders at the settlement price. session_profit_loss is the sum of each holder’s total session P&L (realized + unrealized) across all participants.

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/public/get_last_settlements_by_instrument \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 5482,
  "method": "public/get_last_settlements_by_instrument",
  "params": {
    "instrument_name": "BTC-22FEB19",
    "type": "settlement",
    "count": 1
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 5482,
  "result": {
    "settlements": [
      {
        "type": "settlement",
        "timestamp": 1550502000023,
        "session_profit_loss": 0.116509752,
        "profit_loss": -9.999999999886402e-10,
        "position": 240,
        "mark_price": 3578.16,
        "instrument_name": "BTC-22FEB19",
        "index_price": 3796.43
      }
    ],
    "continuation": "2Z7mdtavzYvfuyYcHkJXvPTr9ZSMsEzM3sLCH7AbYEDd1AzTXY2hnhegQDiaP1TtU4b5iSJZ4"
  }
}

Query Parameters

instrument_name · string · required

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

type · enum<string>

Settlement type The type of settlement event. settlement: daily settlement of futures and perpetual positions at 08:00 UTC, converting unrealized profit and loss into realized profit and loss (option positions do not settle). delivery: one-time expiration of a futures or options contract at 08:00 UTC, closing any remaining open position at the delivery price (does not apply to perpetual or spot instruments). bankruptcy.

Available options: settlement, delivery, bankruptcy

count · integer

Number of requested items, default - 20, maximum - 1000

Required range: 1 <= x <= 1000

continuation · string

Continuation token for pagination

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

search_start_timestamp · integer

The latest timestamp to return result from (milliseconds since the UNIX epoch) The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. continuation · string · required

Continuation token for pagination.

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

result. settlements · object[] · required

Hide child attributes

result.settlements. funding · number · required

funding (in base currency ; settlement for perpetual product only)

Example:

-0.000002511

result.settlements. index_price · number · required

underlying index price at time of event (in quote currency; settlement and delivery only)

Example:

11008.37

result.settlements. instrument_name · string · required

instrument name (settlement and delivery only)

Example:

"BTC-30MAR18"

result.settlements. position · number · required

position size (in quote currency; settlement and delivery only)

Example:

1000

result.settlements. session_profit_loss · number · required

Platform-wide aggregate total session profit and loss for this settlement event, in base currency. This is the sum of each position holder's session P&L (combining realized and unrealized components) across all users who held positions in the instrument — it is not a per-account value.

Example:

0.001160788

result.settlements. timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.settlements. type · enum<string> · required

The type of settlement event. settlement: daily settlement of futures and perpetual positions at 08:00 UTC, converting unrealized profit and loss into realized profit and loss (option positions do not settle). delivery: one-time expiration of a futures or options contract at 08:00 UTC, closing any remaining open position at the delivery price (does not apply to perpetual or spot instruments). bankruptcy.

Available options: settlement, delivery, bankruptcy

result.settlements. funded · number

funded amount (bankruptcy only)

Example:

0

result.settlements. mark_price · number

mark price for at the settlement time (in quote currency; settlement and delivery only)

Example:

11000

result.settlements. profit_loss · number

Platform-wide aggregate realized profit and loss for this settlement event, in base currency. This is the sum of the realized P&L of every position holder at the settlement or delivery price — it is not a per-account value. Present for settlement and delivery types only.

Example:

0

result.settlements. session_bankruptcy · number

value of session bankruptcy (in base currency; bankruptcy only)

Example:

0.001160788

result.settlements. session_tax · number

total amount of paid taxes/fees (in base currency; bankruptcy only)

Example:

-0.001160788

result.settlements. session_tax_rate · number

rate of paid taxes/fees (in base currency; bankruptcy only)

Example:

0.000103333

result.settlements. socialized · number

the amount of the socialized losses (in base currency; bankruptcy only)

Example:

-0.001160788

id · integer

The id that was sent in the request