Returns a list of the latest National Best Bid & Offer (NBBO) top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | Character | The option symbol, corresponding to the underlying security. | |
| expiration | Character | The expiration date of the options contract | |
| source | Character | Realtime or 15-minute delayed contracts. | [optional] |
| type | Character | The option contract type. | [optional] |
| strike | Numeric | The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional] |
| strike_greater_than | Numeric | The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional] |
| strike_less_than | Numeric | The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional] |
| volume_greater_than | Numeric | The volume of the option contract. This will return options contracts with volumes greater than this amount. | [optional] |
| volume_less_than | Numeric | The volume of the option contract. This will return options contracts with volumes less than this amout. | [optional] |
| open_interest_greater_than | Numeric | The open interest of the option contract. This will return options contracts with open interest greater than this amount. | [optional] |
| open_interest_less_than | Numeric | The open interest of the option contract. This will return options contracts with open interest less than this amount. | [optional] |
| moneyness | Character | The moneyness of the options contracts to return. ‘all' will return all options contracts. ‘in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). ‘out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). ‘near_the_money' will return options contracts that are $0.50 or less away from being in the money. Requires subscription to realtime stock price data. | [optional] |
| stock_price_source | Character | Source for underlying price for calculating Greeks. | [optional] |
| model | Character | Model for calculating Greek values. Default is black_scholes. | [optional] |
| show_extended_price | Logical | Whether to include open close high low type fields. | [optional] |
| include_related_symbols | Logical | Include related symbols that end in a 1 or 2 because of a corporate action. | [optional] |
| Name | Type | Description |
|---|---|---|
| chain | List of OptionChainRealtime | A list of realtime options for the provided expiration date their respective option prices. |
| chain_data_frame | Data Frame | Data frame representation of chain |
| Name | Type | Description |
|---|---|---|
| code | Character | The Intrinio Code for the Option. |
| ticker | Character | The ticker symbol of the Security for the Option. |
| expiration | Date | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised. |
| strike | Numeric | The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative's underlying asset. In a call option, the strike price is the price at which the option holder can purchase the underlying security. For a put option, the strike price is the price at which the option holder can sell the underlying security. |
| type | Character | The type of Option (put or call). |
| Name | Type | Description |
|---|---|---|
| last | Numeric | The price of the last trade |
| last_size | Integer | The size of the last trade |
| last_timestamp | POSIXlt | The time of the last trade |
| volume | Integer | The cumulative volume of this options contract that traded that day. |
| ask | Numeric | The price of the top ask order |
| ask_size | Integer | The size of the top ask order |
| ask_timestamp | POSIXlt | The timestamp of the top ask order |
| bid | Numeric | The price of the top bid order |
| bid_size | Integer | The size of the top bid order |
| bid_timestamp | POSIXlt | The time of the top bid order |
| open_interest | Integer | The total number of this options contract that are still open. |
| exercise_style | Character | The exercise style of the option. ("A" = "American", "E" = "European") |
| Name | Type | Description |
|---|---|---|
| implied_volatility | Numeric | The implied volatility of the contract calculated using the Black-Scholes Model. |
| delta | Numeric | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price. |
| gamma | Numeric | Gamma represents the rate of change between an option's delta and the underlying asset's price. |
| theta | Numeric | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay. |
| vega | Numeric | Vega represents the rate of change between an option's value and the underlying asset's implied volatility. |
| underlying_price | Numeric | The most recent trade price of the underlying asset. |
| Name | Type | Description |
|---|---|---|
| bid_open | Numeric | The price of the bid at open |
| bid_high | Numeric | The high bid so far today |
| bid_low | Numeric | The low bid so far today |
| ask_open | Numeric | The price of the ask at open |
| ask_high | Numeric | The high ask so far today |
| ask_low | Numeric | The low ask so far today |
| trade_open | Numeric | The price of the trade at open |
| trade_high | Numeric | The high trade so far today |
| trade_low | Numeric | The low trade so far today |
| ask_close | Numeric | The price of ask at close today |
| bid_close | Numeric | The price of bid at close today |
| trade_close | Numeric | The price of the last trade of the day |
| mark | Numeric | The mark price |
Back to Product Docs