> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Settlements Stream

This stream provides settlement results for your positions at expiry. Subscribe with the
`optionsSettlements` subscription, then request a snapshot with `emitOptionsSettlements`.
See [Settlement & Expiry](/latest/options/guides/settlement-and-expiry) for how
settlement works.

### Settlements Snapshot Request

#### Request

```json theme={null}
{
  "message": "emitOptionsSettlements",
  "content": {
    "clientRequestId": "5aa61e15-9e0f-4d59-975b-58f622362763",
    "market": "BTC-3JUL26-55000-C",
    "limit": 100
  }
}
```

| Field                     | Type   | Required | Description                                          |
| ------------------------- | ------ | -------- | ---------------------------------------------------- |
| `message`                 | string | Yes      | `emitOptionsSettlements`                             |
| `content.clientRequestId` | string | No       | Client-generated UUID for correlation                |
| `content.market`          | string | No       | A contract name to filter, or `ALL` for every market |
| `content.limit`           | number | No       | Maximum number of settlements to return              |

#### Response

```json theme={null}
{
  "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"
  }
}
```

| Field                                | Type   | Required | Description                           |
| ------------------------------------ | ------ | -------- | ------------------------------------- |
| `resultType`                         | string | Yes      | `optionsSettlements`                  |
| `market`                             | string | Yes      | Contract name                         |
| `data.settlements[].market`          | string | Yes      | Contract name                         |
| `data.settlements[].side`            | string | Yes      | `long` or `short`                     |
| `data.settlements[].optionType`      | string | Yes      | `call` or `put`                       |
| `data.settlements[].qty`             | string | Yes      | Settled quantity                      |
| `data.settlements[].value`           | string | Yes      | Position value                        |
| `data.settlements[].entryPrice`      | string | Yes      | Average entry price                   |
| `data.settlements[].markPrice`       | string | Yes      | Mark price at settlement              |
| `data.settlements[].underlyingPrice` | string | Yes      | Underlying price at settlement        |
| `data.settlements[].breakEvenPrice`  | string | Yes      | Break-even price                      |
| `data.settlements[].settlementPrice` | string | Yes      | Settlement price of the underlying    |
| `data.settlements[].payoff`          | string | Yes      | Payoff at settlement                  |
| `data.settlements[].deliveryFee`     | string | Yes      | Delivery fee charged at settlement    |
| `data.settlements[].realizedPnl`     | string | Yes      | Realized PnL from settlement          |
| `data.settlements[].settledAt`       | number | Yes      | Settlement time (seconds since epoch) |
| `data.statusCode`                    | number | Yes      | `200`                                 |
| `data.clientRequestId`               | string | No       | Client-generated UUID for correlation |