Options by Symbol Realtime

Options by Symbol Realtime Ruby API Documentation

Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.

API Class:
Intrinio::OptionsApi
Instance Method:
get_options_by_symbol_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
symbol = "AAPL"
opts = {
type: "put",
strike: 170,
strike_greater_than: 150,
strike_less_than: 190,
expiration: "2022-04-16",
expiration_after: "2022-01-01",
expiration_before: "2023-12-31",
source: nil,
include_related_symbols: false
}
result = options_api.get_options_by_symbol_realtime(symbol, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
symbolStringThe option symbol, corresponding to the underlying security. 
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]  
expirationStringThe expiration date of the option contract. This will return options contracts with expiration dates on this date.[optional]  
expiration_afterStringThe expiration date of the option contract. This will return options contracts with expiration dates after this date.[optional]  
expiration_beforeStringThe expiration date of the option contract. This will return options contracts with expiration dates before this date.[optional]  
sourceStringRealtime or 15-minute delayed contracts.[optional]  
include_related_symbolsBOOLEANInclude related symbols that end in a 1 or 2 because of a corporate action.[optional]  

Return Type

object
Intrinio::ApiResponseOptionsRealtime

Properties

NameTypeDescription
optionsArrayA list of options contracts with the given symbol  
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).