Option Stats Realtime

Option Stats Realtime Ruby API Documentation

Returns all option stats (greeks and implied volatility) as well as the underlying factors used to calculate them, for a particular option contract.

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

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
identifier = "AAPL230120C00090000"
opts = {
source: nil,
show_extended_price: nil
}
result = options_api.get_options_stats_realtime(identifier, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringThe Intrinio ID or code of the options contract to request prices for. 
sourceStringRealtime or 15-minute delayed contracts.[optional]  
show_extended_priceBOOLEANWhether to include open close high low type fields.[optional]  

Return Type

object
Intrinio::ApiResponseOptionsStatsRealtime

Properties

NameTypeDescription
statsOptionStatsRealtime 
factorsOptionFactorsRealtime 
optionOptionRealtime 
object
Intrinio::OptionStatsRealtime

Properties

NameTypeDescription
implied_volatilityFloatThe implied volatility of the contract calculated using the Black-Scholes Model.  
deltaFloatDelta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
gammaFloatGamma represents the rate of change between an option's delta and the underlying asset's price.  
thetaFloatTheta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
vegaFloatVega represents the rate of change between an option's value and the underlying asset's implied volatility.  
underlying_priceFloatThe most recent trade price of the underlying asset.  
object
Intrinio::OptionFactorsRealtime

Properties

NameTypeDescription
market_priceFloatThe market price of the options contract  
underlying_priceFloatThe market price of the underlying asset  
strike_priceFloatThe strike price of the options contract  
days_to_expirationFloatThe number of days to expiration  
risk_free_interest_rateFloatThe current risk-free interest rate, as measured by the 3-month Treasury Bill rate  
dividend_yieldFloatThe dividend yield of the underlying asset (if applicable)  
object
Intrinio::OptionRealtime

Properties

NameTypeDescription
codeStringThe Intrinio Code for the Option.  
tickerStringThe ticker symbol of the Security for the Option.  
expirationDateThe 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).