Web APIFIX API
API Reference
API StatusLogin

Retrieve Instrument Options Chain

get
https://bo-api.drivewealth.io/back-office/instruments//options

Retrieves an Instrument Options Chain by symbol or instrumentID.

Path Params
string
required

Symbol or instrumentID of the underlying equity security

Query Params
date

Optional expiration date of the option security to filter by.

integer
integer

The number of option instruments to be returned per page.

string
enum
Defaults to asc

The sorting order of option instruments.

Show Details
ascSort in ascending order.
descSort in descending order.
Allowed:
integer

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

integer

The option instruments to be returned above the strike price.

integer

The option instruments to be returned below the strike price.

string
enum

The type of option instruments to be returned.

Show Details
CALLA call option, giving the right to buy the underlying instrument.
PUTA put option, giving the right to sell the underlying instrument.
Allowed:
string

The instrument ID of the option security.

string

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

Response

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 4 months ago

Did this page help you?