Options Chain

Options Chain Ruby API Documentation

Returns a list of the historical end-of-day 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. Available via a 3rd party, contact sales for a trial.

API Class:
Intrinio::OptionsApi
Instance Method:
get_options_chain()

Stock Price Code Example

Use my API Key
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
config.api_key['api_key'] = 'YOUR_API_KEY'
config.allow_retries = true
end
options_api = Intrinio::OptionsApi.new
symbol = "MSFT"
expiration = "2019-04-05"
opts = {
date: nil,
type: nil,
strike: nil,
strike_greater_than: nil,
strike_less_than: nil,
moneyness: nil,
page_size: 100
}
result = options_api.get_options_chain(symbol, expiration, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
symbolStringThe option symbol, corresponding to the underlying security. 
expirationStringThe expiration date of the options contract 
dateDateThe date of the option price. Returns option prices on this date.[optional]  
typeStringThe option contract type.[optional]  
strikeFloatThe strike price of the option contract. This will return options contracts with strike price equal to this price.[optional]  
strike_greater_thanFloatThe strike price of the option contract. This will return options contracts with strike prices greater than this price.[optional]  
strike_less_thanFloatThe strike price of the option contract. This will return options contracts with strike prices less than this price.[optional]  
moneynessStringThe 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.[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  

Return Type

object
Intrinio::ApiResponseOptionsChain

Properties

NameTypeDescription
chainArrayA list of options for the provided expiration date their respective option prices.  
object
Intrinio::OptionChain

Properties

NameTypeDescription
optionOption 
priceOptionPrice 
object
Intrinio::Option

Properties

NameTypeDescription
idStringThe Intrinio ID for the Option.  
codeStringThe Intrinio Code for the Option.  
tickerStringThe ticker symbol of the Security for the Option.  
expirationStringThe date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
strikeFloatThe 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.  
typeStringThe type of Option (put or call). A put option is an option contract giving the owner the right, but not the obligation, to sell a specified amount of an underlying asset at a specified price before the option's expiration date. A call option gives the holder the right to buy an underlying asset at a specified price, before the option's expiration date.  
object
Intrinio::OptionPrice

Properties

NameTypeDescription
dateStringThe date of the price, in the format YYYY-MM-DD  
closeFloatThe closing price of the options contract.  
close_bidFloatThe closing bid price of the options contract.  
close_askFloatThe closing ask price of the options contract.  
volumeIntegerThe cumulative volume of this options contract that traded that day.  
volume_bidIntegerThe cumulative volume of this options contract that traded on the bid price that day.  
volume_askIntegerThe cumulative volume of this options contract that traded on the ask price that day.  
tradesIntegerThe number of trades executed that for this options contract on that day.  
open_interestIntegerThe total number of this options contract that are still open.  
open_interest_changeIntegerThe change in the total number of this options contract that are still open from the previous day.  
next_day_open_interestIntegerThe total number of this options contract that are still open at the start of the next day.  
implied_volatilityFloatThe estimated volatility of the Security's price. Volatility is a statistical measure of dispersion of returns for the Security. Standard deviation of a Security's returns and a market index is an example of a measurement of volatility. Implied volatility approximates the future value of an option, and the option's current value takes this into consideration.  
implied_volatility_changeFloatThe change in implied volatility for that day.  
deltaFloatDelta measures the degree to which an options contract is exposed to shifts in the price of the underlying Security. Values of delta range from 0.0 to 1.0 for call options and -1.0 to 0.0 for put options. For example, if a put option has a delta of -0.50, if the price of the underlying Security increases by $1, the price of the put option will decrease by $0.50.