latestOpenAPI 3.1.02026-08-145096557.0 KB

1c983de099e2

us-equity-opt-ref-sec-master-lookups

US Options Security Master

The U.S. Options Security Master dataset provides a root-level reference catalog of all listed and delisted U.S. options disseminated via OPRA, covering options on equities, ETFs, ETNs, indexes, and currencies from 2012 to the present. Each record represents an option root security and includes summary attributes such as option type, settlement type, underlying symbol, and underlying security type. This dataset is designed to define the structural identity of an option root, rather than individual expirations or strikes. The security master is organized using algoseek’s persistent algoseek Security Identifier (ASID). The ASID remains stable throughout the lifecycle of an option root, even as individual contracts (strikes and expirations) are listed and expire. This enables consistent root-level mapping and simplifies integration across downstream options datasets. The dataset is delivered as a single, consolidated file and is updated daily. Companion lookup files are available to map ASID to option root symbols and underlying symbols, supporting efficient identifier resolution and cross-dataset joins.

For more details, please refer to the dataset documentation: US Options Security Master 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/sec-master

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": [
    {
      "ASID": 1110000000001000,
      "OptionTicker": "A",
      "UnderTicker": "A",
      "UnderType": "S",
      "OptionType": "VA",
      "OptionStyle": "A",
      "IsWeekly": "N",
      "MarketClose": "16:00",
      "SettlType": "PM",
      "OptionTradeDates": [
        "20120103:29991231"
      ],
      "OptionListStatus": "L",
      "UnderSecId": 32952,
      "UnderTradeDates": [
        "20070103:29991231"
      ],
      "GreeksCoverage": "Y"
    }
  ],
  "pagination": {
    "limit": 1000,
    "next_offset": 2000,
    "offset": 1000
  }
}