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 ticker.
| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | Character | The equities ticker symbol, corresponding to the underlying security. | |
| source | Character | Realtime or 15-minute delayed contracts. | [optional] |
| iv_mode | Character | Change the mode for the implied volatility calculation to out of the money. | [optional] |
| next_page | Character | Gets the next page of data from a previous API call | [optional] |
| page_size | Integer | The number of results to return | [optional] [default to 250] |
| 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] |
| expiration_start_date | TODO_OBJECT_MAPPING | Filter out contracts that expire before this date. | [optional] |
| expiration_end_date | TODO_OBJECT_MAPPING | Filter out contracts that expire after this date. | [optional] |
| Name | Type | Description |
|---|---|---|
| security | SecuritySummary | The Security resolved from the given identifier |
| next_page | Character | The token required to request the next page of the data. If null, no further results are available. |
| contracts | List of ApiResponseOptionsPriceRealtime | The contracts pricing for this security. |
| contracts_data_frame | Data Frame | Data frame representation of contracts |
| Name | Type | Description |
|---|---|---|
| id | Character | The Intrinio ID for Security |
| company_id | Character | The Intrinio ID for the Company for which the Security is issued |
| exchange | Character | The exchange's MIC |
| exchange_mic | Character | The security's exchange MIC |
| stock_exchange_id | Character | The exchange's Intrinio ID |
| name | Character | The name of the Security |
| code | Character | A 2-3 digit code classifying the Security (reference) |
| currency | Character | The currency in which the Security is traded on the exchange |
| ticker | Character | The common/local ticker of the Security |
| composite_ticker | Character | The country-composite ticker of the Security |
| figi | Character | The OpenFIGI identifier |
| composite_figi | Character | The country-composite OpenFIGI identifier |
| share_class_figi | Character | The global-composite OpenFIGI identifier |
| primary_listing | Logical | If TRUE, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange |
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| 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