OCC Equities Special Settlements

GET https://api.devalgoseek.com/api/v1/data/us-equity-opt-ref/occ-eq-spec-settl#

The OCC Equities Special Settlements dataset is derived from official Options Clearing Corporation records and provides authoritative coverage of non-standard (adjusted) U.S. equity option contracts resulting from corporate actions such as mergers, splits, spin-offs, or special dividends.The dataset includes key identifiers such as the adjusted option symbol and underlying equity symbol, along with detailed settlement mechanics describing how exercise and assignment obligations were resolved. This includes information on delivery components, enabling users to accurately interpret post-adjustment contract terms and cash-and-carry outcomes. Data is available on a daily basis starting November 1, 2017, and is designed to support historical research, back-testing, compliance validation, and institutional-grade options analytics involving complex or non-standard contracts.

For more details, please refer to the dataset documentation: OCC Equities Special Settlements Guide.

Advanced Filtering

You can provide one or multiple filter expressions based on the dataset's columns to narrow down the results. For example, StartDate.gt=2023-01-01&StartDate.lt=2023-12-31, Ticker=AAPL.

Please refer to the Advanced Filtering Guide for the extensive reference.

Request#

Query Parameters#

sort Sort

Sorting criteria for the results. Provide a column name with optional prefix '+' for ascending order, or prefix with '-' for descending order. Multiple sorting fields may be supported depending on the dataset. If sort prefix is not provided, the ascending order is applied.

columns Columns

A comma-separated list of columns to include in the response. Use this parameter to select only specific fields from the dataset. If not provided, all available columns will be returned.

offset Offset

Possible values: >= 0

Number of records to skip before returning results. To be used with the limit parameter for pagination. If not provided, defaults to 0.

Default value: 0

Example: 100

limit Limit

Possible values: >= 0 and <= 100000

Maximum number of records to return. Used to control response size and pagination. If not provided, a default limit is applied by the server.

Default value: 10000

Example: 100

response_format ResponseFormat

Possible values: [json, csv, csv_gzip]

The type of the data to return

Default value: json

Examples:

JSON
CSV Gzip

JSON format (default)

Example: json

Compressed CSV format

Example: csv_gzip

Responses#

JSON, CSV file, or gzip-compressed CSV file, depending on the value of response_format query parameter

application/json
text/csv
application/gzip

Schema
Example (auto)

Schema

data object[]required

Array [

ProcessDatedate

The date on which the record was created by OCC

Example: 20240315

SettlementDatedate

The date on which delivery of and payment for product is due to

Example:

OptionTickerstring

Symbol name

Example: AAGR1

UnderTickerstring

Underlying symbol name

Example: AAGR

UnderTypestring

Type of underlying security

Example: S

StrikeCurrencystring

The currency of the strike price

Example: USD

TotalDelivComponentsinteger

The total number of components of delivery associated with the settlement of the traded option symbol

Example: 1

DeliveryComponentsinteger

The number of a specific component of delivery that is represented by the record

Example: 1

SettlementMethodstring

The manner in which exercise and assignment activity will be settled

Example: CNS

StrikePercentinteger

Percentage of the strike price allocated for settlement

Example: 100

DeliverableUnitsinteger

The per-contract number of deliverable units of cash, stocks, bonds, or currencies to be delivered or received upon settlement

Example: 140

CashAmountnumber

Per-contract cash amount to be allocated upon settlement

Example: 0

]

pagination objectrequired

offsetinteger

The number of records skipped to fetch the current page

Default value: 0

limitintegerrequired

The maximum number of records in the current page

next_offsetinteger

The number of records to skip to fetch the next page

{
  "data": [
    {
      "ProcessDate": "20240315",
      "SettlementDate": "",
      "OptionTicker": "AAGR1",
      "UnderTicker": "AAGR",
      "UnderType": "S",
      "StrikeCurrency": "USD",
      "TotalDelivComponents": 1,
      "DeliveryComponents": 1,
      "SettlementMethod": "CNS",
      "StrikePercent": 100,
      "DeliverableUnits": 140,
      "CashAmount": 0
    }
  ],
  "pagination": {
    "limit": 1000,
    "next_offset": 2000,
    "offset": 1000
  }
}

Schema
Example (auto)

Schema

stringbinary

"string"

Schema
Example (auto)

Schema

stringbinary

"string"

Validation Error

application/json

Schema
Example (auto)

Schema

detail object[]

Array [

loc object[]required

Array [

anyOf

string
integer

string

]

msgstringrequired

typestringrequired

inputInput

ctxobject

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string",
      "ctx": {}
    }
  ]
}

Authorization: X-API-KEY#

name: X-API-KEYtype: apiKeyin: header

HTTPCLIENT
RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.devalgoseek.com/api/v1/data/us-equity-opt-ref/occ-eq-spec-settl");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

Click the Send API Request button above and see the response here!

← Previous

Get dataset status

US Equities ASID Lookup