> ## 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 > Settlement results at expiry. This stream is available on the `optionsSettlements` subscription. It provides settlement results for your positions at expiry. See [Settlement & Expiry](/latest/options/guides/settlement-and-expiry) for how settlement works. #### Snapshot Request The `emitOptionsSettlements` request returns a snapshot of your settlement history via `optionsSettlements`. ## AsyncAPI ````yaml latest/options/asyncapi/options-ws.yaml settlementsStream id: settlementsStream title: Settlements Stream description: >- Available on the `optionsSettlements` subscription. Settlement results for your positions at expiry. servers: - id: sandbox protocol: wss host: ws.sandbox.rails.xyz bindings: [] variables: [] address: >- ?product=options&market={market}&expiration={expiration}&strike={strike}&type={type}&subscriptions=optionsSettlements parameters: - id: market jsonSchema: type: string description: A specific market (e.g. `BTC-USDT`) or `ALL`. default: BTC-USDT description: A specific market (e.g. `BTC-USDT`) or `ALL`. type: string required: true deprecated: false - id: expiration jsonSchema: type: string description: >- Contract expiration, e.g. `24JUN26`. Requires `market`; omit to match every expiration. default: 24JUN26 description: >- Contract expiration, e.g. `24JUN26`. Requires `market`; omit to match every expiration. type: string required: true deprecated: false - id: strike jsonSchema: type: string description: >- Strike price, e.g. `62000`. Requires `expiration`; omit to match every strike. default: '62000' description: >- Strike price, e.g. `62000`. Requires `expiration`; omit to match every strike. type: string required: true deprecated: false - id: type jsonSchema: type: string description: '`C` (call) or `P` (put). Requires `strike`; omit to match both.' default: C description: '`C` (call) or `P` (put). Requires `strike`; omit to match both.' type: string required: true deprecated: false bindings: [] operations: - &ref_1 id: emitOptionsSettlements title: Emit options settlements description: Request a snapshot of your settlement history. type: receive messages: - &ref_3 id: emitOptionsSettlementsRequest contentType: application/json payload: - name: Emit Options Settlements type: object properties: - name: message type: string description: Always `emitOptionsSettlements`. required: true - name: content type: object required: false properties: - name: clientRequestId type: string description: Client-generated UUID for correlation required: false - name: market type: string description: A contract name to filter, or `ALL` for every market required: false - name: limit type: integer description: Maximum number of settlements to return required: false headers: [] jsonPayloadSchema: type: object properties: message: type: string description: Always `emitOptionsSettlements`. x-parser-schema-id: content: type: object properties: clientRequestId: type: string format: uuid description: Client-generated UUID for correlation x-parser-schema-id: market: type: string description: A contract name to filter, or `ALL` for every market x-parser-schema-id: limit: type: integer description: Maximum number of settlements to return x-parser-schema-id: x-parser-schema-id: required: - message x-parser-schema-id: title: Emit Options Settlements example: |- { "message": "emitOptionsSettlements", "content": { "clientRequestId": "5aa61e15-9e0f-4d59-975b-58f622362763", "market": "BTC-3JUL26-55000-C", "limit": 100 } } bindings: [] extensions: - id: x-parser-unique-object-id value: emitOptionsSettlementsRequest bindings: [] extensions: &ref_0 - id: x-parser-unique-object-id value: settlementsStream - &ref_2 id: optionsSettlementsSnapshot title: Options settlements snapshot description: Response to `emitOptionsSettlements`. type: send messages: - &ref_4 id: optionsSettlementsResponse contentType: application/json payload: - name: Settlements Snapshot description: Response to `emitOptionsSettlements`. type: object properties: - name: resultType type: string description: Always `optionsSettlements`. required: true - name: market type: string description: Contract name, or `ALL` required: true - name: data type: object required: true properties: - name: settlements type: array description: Settlement results required: true properties: - name: contract type: string description: Contract name required: true - name: side type: string description: Position side enumValues: - long - short required: true - name: optionType type: string description: >- Option type — `C` (call) or `P` (put), matching the contract name enumValues: - C - P required: true - name: qty type: string description: Settled quantity required: true - name: value type: string description: Position value required: true - name: entryPrice type: string description: Average entry price required: true - name: markPrice type: string description: Mark price at settlement required: true - name: underlyingPrice type: string description: Underlying price at settlement required: true - name: breakEvenPrice type: string description: Break-even price required: true - name: settlementPrice type: string description: Settlement price of the underlying required: true - name: payoff type: string description: Payoff at settlement required: true - name: deliveryFee type: string description: Delivery fee charged at settlement required: true - name: realizedPnl type: string description: Realized PnL from settlement required: true - name: settledAt type: integer description: Settlement time (ms since epoch) required: true - name: statusCode type: integer description: Always `200`. required: true - name: clientRequestId type: string description: Client-generated UUID for correlation required: false headers: [] jsonPayloadSchema: type: object properties: resultType: type: string description: Always `optionsSettlements`. x-parser-schema-id: market: type: string description: Contract name, or `ALL` x-parser-schema-id: data: type: object properties: settlements: type: array description: Settlement results items: type: object properties: contract: type: string description: Contract name x-parser-schema-id: side: type: string enum: - long - short description: Position side x-parser-schema-id: optionType: type: string enum: - C - P description: >- Option type — `C` (call) or `P` (put), matching the contract name x-parser-schema-id: qty: type: string description: Settled quantity x-parser-schema-id: value: type: string description: Position value x-parser-schema-id: entryPrice: type: string description: Average entry price x-parser-schema-id: markPrice: type: string description: Mark price at settlement x-parser-schema-id: underlyingPrice: type: string description: Underlying price at settlement x-parser-schema-id: breakEvenPrice: type: string description: Break-even price x-parser-schema-id: settlementPrice: type: string description: Settlement price of the underlying x-parser-schema-id: payoff: type: string description: Payoff at settlement x-parser-schema-id: deliveryFee: type: string description: Delivery fee charged at settlement x-parser-schema-id: realizedPnl: type: string description: Realized PnL from settlement x-parser-schema-id: settledAt: type: integer description: Settlement time (ms since epoch) x-parser-schema-id: required: - contract - side - optionType - qty - value - entryPrice - markPrice - underlyingPrice - breakEvenPrice - settlementPrice - payoff - deliveryFee - realizedPnl - settledAt x-parser-schema-id: Settlement x-parser-schema-id: statusCode: type: integer description: Always `200`. x-parser-schema-id: clientRequestId: type: string description: Client-generated UUID for correlation x-parser-schema-id: required: - settlements - statusCode x-parser-schema-id: required: - resultType - market - data x-parser-schema-id: title: Settlements Snapshot description: Response to `emitOptionsSettlements`. example: |- { "resultType": "optionsSettlements", "market": "BTC-3JUL26-55000-C", "data": { "settlements": [ { "contract": "BTC-3JUL26-55000-C", "side": "long", "optionType": "C", "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": 1783065647000 } ], "statusCode": 200, "clientRequestId": "5aa61e15-9e0f-4d59-975b-58f622362763" } } bindings: [] extensions: - id: x-parser-unique-object-id value: optionsSettlementsResponse bindings: [] extensions: *ref_0 sendOperations: - *ref_1 receiveOperations: - *ref_2 sendMessages: - *ref_3 receiveMessages: - *ref_4 extensions: - id: x-parser-unique-object-id value: settlementsStream securitySchemes: - id: wsAuth name: Sec-WebSocket-Protocol type: httpApiKey description: Supply as `authorization#` during the WebSocket handshake. in: header extensions: [] ````