Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Instruments

Retrieve Instrument Options Chain

Retrieves an Instrument Options Chain by symbol or instrumentID.

get/instruments/{symbolOrInstrumentID}/options

Path parameters

symbolOrInstrumentIDstring required

Symbol or instrumentID of the underlying equity security

Query parameters

expirationDatestring date

Optional expiration date of the option security to filter by.

pageinteger
pageSizeinteger

The number of option instruments to be returned per page.

sortOrder'asc' | 'desc'

The sorting order of option instruments.

noOfStrikesinteger

The number of option instruments to be returned above and below market price.

minStrikePriceinteger

The option instruments to be returned above the strike price.

maxStrikePriceinteger

The option instruments to be returned below the strike price.

optionType'CALL' | 'PUT'

The type of option instruments to be returned.

idstring

The instrument ID of the option security.

filterBystring

The expiration dates for the given underlying security; to filter by.

Response

Retrieving an Instrument Options Chain by symbol or instrumentID was Successful.

symbolstring

Option OSI symbol

Example response

{
  "symbol": "AAPL220517P00016000",
  "options": [
    {
      "id": "3fb1e8a9-f7d5-4d90-95e2-43e7326b5636",
      "symbol": "AAPL220517P00016000",
      "type": "EQUITY",
      "name": "Morgan Stanley",
      "exchange": "NYQ",
      "orderSizeMax": 20000,
      "orderSizeMin": 0.1,
      "orderSizeStep": 0.01
    }
  ]
}