Retrieve Instrument Options Chain

get

https://bo-api.drivewealth.io/back-office/instruments/{symbolOrInstrumentID}/options

Retrieves an Instrument Options Chain by symbol or instrumentID.

Path Params

symbolOrInstrumentID

string

required

Symbol or instrumentID of the underlying equity security

Query Params

expirationDate

string

required

The expiration date of the option security; to filter by.

page

integer

pageSize

integer

The number of option instruments to be returned per page.

sortOrder

string

enum

Defaults to asc

The sorting order of option instruments.

Allowed:

noOfStrikes

integer

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

minStrikePrice

integer

The option instruments to be returned above the strike price.

maxStrikePrice

integer

The option instruments to be returned below the strike price.

optionType

string

enum

The type of option instruments to be returned.

Allowed:

string

The instrument ID of the option security.

filterBy

string

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

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

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