Options Chain Realtime Javascript API Documentation

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.

API Class:

OptionsApi

Instance Method:

getOptionsChainRealtime()

Stock Price Code Example

Use my API Key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var options = new intrinioSDK.OptionsApi();
var symbol = "MSFT";
var expiration = "2023-01-20";
var opts = { 
  'source': null,
  'type': null,
  'strike': null,
  'strikeGreaterThan': null,
  'strikeLessThan': null,
  'volumeGreaterThan': null,
  'volumeLessThan': null,
  'openInterestGreaterThan': null,
  'openInterestLessThan': null,
  'moneyness': null,
  'stockPriceSource': null,
  'model': null,
  'showExtendedPrice': null,
  'includeRelatedSymbols': false
};
options.getOptionsChainRealtime(symbol, expiration, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
symbol	String	The option symbol, corresponding to the underlying security.
expiration	String	The expiration date of the options contract
source	String	Realtime or 15-minute delayed contracts.	[optional]
type	String	The option contract type.	[optional]
strike	Number	The strike price of the option contract. This will return options contracts with strike price equal to this price.	[optional]
strikeGreaterThan	Number	The strike price of the option contract. This will return options contracts with strike prices greater than this price.	[optional]
strikeLessThan	Number	The strike price of the option contract. This will return options contracts with strike prices less than this price.	[optional]
volumeGreaterThan	Number	The volume of the option contract. This will return options contracts with volumes greater than this amount.	[optional]
volumeLessThan	Number	The volume of the option contract. This will return options contracts with volumes less than this amout.	[optional]
openInterestGreaterThan	Number	The open interest of the option contract. This will return options contracts with open interest greater than this amount.	[optional]
openInterestLessThan	Number	The open interest of the option contract. This will return options contracts with open interest less than this amount.	[optional]
moneyness	String	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]
stockPriceSource	String	Source for underlying price for calculating Greeks.	[optional]
model	String	Model for calculating Greek values. Default is black_scholes.	[optional]
showExtendedPrice	Boolean	Whether to include open close high low type fields.	[optional]
includeRelatedSymbols	Boolean	Include related symbols that end in a 1 or 2 because of a corporate action.	[optional]

Return Type

object

ApiResponseOptionsChainRealtime

Properties

Name	Type	Description
chain	[OptionChainRealtime]	A list of realtime options for the provided expiration date their respective option prices.

Name	Type	Description
option	OptionRealtime
price	OptionPriceRealtime
stats	OptionStatsRealtime
extendedPrice	OptionPriceRealtimeExtended

object

OptionRealtime

Properties

Name	Type	Description
code	String	The Intrinio Code for the Option.
ticker	String	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	Number	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	String	The type of Option (put or call).

object

OptionPriceRealtime

Properties

Name	Type	Description
last	Number	The price of the last trade
lastSize	Number	The size of the last trade
lastTimestamp	Date	The time of the last trade
volume	Number	The cumulative volume of this options contract that traded that day.
ask	Number	The price of the top ask order
askSize	Number	The size of the top ask order
askTimestamp	Date	The timestamp of the top ask order
bid	Number	The price of the top bid order
bidSize	Number	The size of the top bid order
bidTimestamp	Date	The time of the top bid order
openInterest	Number	The total number of this options contract that are still open.
exerciseStyle	String	The exercise style of the option. ("A" = "American", "E" = "European")

object

OptionStatsRealtime

Properties

Name	Type	Description
impliedVolatility	Number	The implied volatility of the contract calculated using the Black-Scholes Model.
delta	Number	Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.
gamma	Number	Gamma represents the rate of change between an option's delta and the underlying asset's price.
theta	Number	Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.
vega	Number	Vega represents the rate of change between an option's value and the underlying asset's implied volatility.
underlyingPrice	Number	The most recent trade price of the underlying asset.

object

OptionPriceRealtimeExtended

Properties

Name	Type	Description
bidOpen	Number	The price of the bid at open
bidHigh	Number	The high bid so far today
bidLow	Number	The low bid so far today
askOpen	Number	The price of the ask at open
askHigh	Number	The high ask so far today
askLow	Number	The low ask so far today
tradeOpen	Number	The price of the trade at open
tradeHigh	Number	The high trade so far today
tradeLow	Number	The low trade so far today
askClose	Number	The price of ask at close today
bidClose	Number	The price of bid at close today
tradeClose	Number	The price of the last trade of the day
mark	Number	The mark price

SDKs

C# SDK

Java SDK

JavaScript SDK

Python SDK

R SDK

Ruby SDK

Real-Time Options - API Endpoints

Option Prices Realtime

Options Chain Realtime

Option Stats Realtime

Options Expirations

Options by Symbol Realtime

Option Prices Batch Realtime

Options Unusual Activity

Options Unusual Activity Intraday

Options Unusual Activity Universal

Options Unusual Activity Universal Intraday

Option Strikes Realtime

Option Prices Realtime Snapshot

Options Chain Realtime Javascript API Documentation

Stock Price Code Example

Parameters

Return Type

Properties

Properties

Properties

Properties

Properties

Properties