latestOpenAPI 3.1.02026-08-145096557.0 KB

1c983de099e2

us-equity-opt-ref-market-structure-compliance

OCC Equities Special Settlements

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.

<details> <summary>**Advanced Filtering**</summary>

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 <a href="https://algoseek.com/docs/rest-api/tutorial/advanced-filtering">Advanced Filtering Guide</a> for the extensive reference.

</details>
get/v1/data/us-equity-opt-ref/occ-eq-spec-settl

Query parameters

sortstring nullable

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.

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.

columnsstring nullable

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.

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.

offsetinteger

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

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

limitinteger

Maximum number of records to return. Default and maximum values depend on the response format; see format_limits in the schema for details.

Maximum number of records to return. Default and maximum values depend on the response format; see format_limits in the schema for details.

response_format'json' | 'csv' | 'csv_gzip'

Note the lowercase which is used for the consistency with other projects and tools

The type of the data to return

Response

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

Example response

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