MAmassive
us_options

GET /options/vX/open-interest/underlying

Changed on

Daily open interest for US options rolled up across each underlying's whole chain, as reported by OPRA, with the call and put split.

Request

  • Base URL
    https://api.massive.com
  • URL
    https://api.massive.com/options/vX/open-interest/underlying
  • Auth
    API key in query parameter apiKey

Query parameters

underlying_tickerstring

The ticker of the underlying (e.g., SPX). Totals cover every root on the underlying, so weekly roots (SPXW) and roots adjusted after a corporate action (AMCR1) are included.

underlying_ticker.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list.

underlying_ticker.gtstring

Filter greater than the value.

underlying_ticker.gtestring

Filter greater than or equal to the value.

underlying_ticker.ltstring

Filter less than the value.

underlying_ticker.ltestring

Filter less than or equal to the value.

datestring

The trading date the open interest applies to (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.

date.gtstring

Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.

date.gtestring

Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.

date.ltstring

Filter less than the value. Value must be formatted 'yyyy-mm-dd'.

date.ltestring

Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.

open_interestinteger

Total open interest across every contract on the underlying. Value must be an integer.

open_interest.gtinteger

Filter greater than the value. Value must be an integer.

open_interest.gteinteger

Filter greater than or equal to the value. Value must be an integer.

open_interest.ltinteger

Filter less than the value. Value must be an integer.

open_interest.lteinteger

Filter less than or equal to the value. Value must be an integer.

limitinteger

Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.

sortstring

A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified.

Response

A list of results.

next_urlstring

If present, this value can be used to fetch the next page.

request_idstring required

A request id assigned by the server.

status'OK' required

The status of this request's response.

Changes