Skip to main content
This stream provides settlement results for your positions at expiry. Subscribe with the optionsSettlements subscription, then request a snapshot with emitOptionsSettlements. See Settlement & Expiry for how settlement works.

​
Settlements Snapshot Request

​
Request

{
  "message": "emitOptionsSettlements",
  "content": {
    "clientRequestId": "5aa61e15-9e0f-4d59-975b-58f622362763",
    "market": "BTC-3JUL26-55000-C",
    "limit": 100
  }
}
FieldTypeRequiredDescription
messagestringYesemitOptionsSettlements
content.clientRequestIdstringNoClient-generated UUID for correlation
content.marketstringNoA contract name to filter, or ALL for every market
content.limitnumberNoMaximum number of settlements to return

​
Response

{
  "resultType": "optionsSettlements",
  "market": "BTC-3JUL26-55000-C",
  "data": {
    "settlements": [
      {
        "market": "BTC-3JUL26-55000-C",
        "side": "long",
        "optionType": "call",
        "qty": "1",
        "value": "6602.92",
        "entryPrice": "6602.92",
        "markPrice": "6761.0002820975",
        "underlyingPrice": "61761.0002820975",
        "breakEvenPrice": "61609.52292",
        "settlementPrice": "61761.0002820975",
        "payoff": "6761.0002820975",
        "deliveryFee": "9.26415",
        "realizedPnl": "158.080282",
        "settledAt": 1783065647
      }
    ],
    "statusCode": 200,
    "clientRequestId": "5aa61e15-9e0f-4d59-975b-58f622362763"
  }
}
FieldTypeRequiredDescription
resultTypestringYesoptionsSettlements
marketstringYesContract name
data.settlements[].marketstringYesContract name
data.settlements[].sidestringYeslong or short
data.settlements[].optionTypestringYescall or put
data.settlements[].qtystringYesSettled quantity
data.settlements[].valuestringYesPosition value
data.settlements[].entryPricestringYesAverage entry price
data.settlements[].markPricestringYesMark price at settlement
data.settlements[].underlyingPricestringYesUnderlying price at settlement
data.settlements[].breakEvenPricestringYesBreak-even price
data.settlements[].settlementPricestringYesSettlement price of the underlying
data.settlements[].payoffstringYesPayoff at settlement
data.settlements[].deliveryFeestringYesDelivery fee charged at settlement
data.settlements[].realizedPnlstringYesRealized PnL from settlement
data.settlements[].settledAtnumberYesSettlement time (seconds since epoch)
data.statusCodenumberYes200
data.clientRequestIdstringNoClient-generated UUID for correlation