Options

Options R 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. Available via a 3rd party, contact sales for a trial.

API Class:
IntrinioSDK::OptionsApi
Instance Method:
get_options()

Stock Price Code Example

Use my API Key
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OptionsApi <- IntrinioSDK::OptionsApi$new(client)
# Required params
symbol <- "AAPL"
# Optional params
opts <- list(
type = "put",
strike = 170,
strike_greater_than = 150,
strike_less_than = 190,
expiration = "2019-03-01",
expiration_after = "2019-01-01",
expiration_before = "2019-12-31",
page_size = 100,
next_page = NULL
)
response <- OptionsApi$get_options(symbol, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
symbolCharacterThe option symbol, corresponding to the underlying security. 
typeCharacterThe option contract type.[optional]  
strikeNumericThe strike price of the option contract. This will return options contracts with strike price equal to this price.[optional]  
strike_greater_thanNumericThe strike price of the option contract. This will return options contracts with strike prices greater than this price.[optional]  
strike_less_thanNumericThe strike price of the option contract. This will return options contracts with strike prices less than this price.[optional]  
expirationCharacterThe expiration date of the option contract. This will return options contracts with expiration dates on this date.[optional]  
expiration_afterCharacterThe expiration date of the option contract. This will return options contracts with expiration dates after this date.[optional]  
expiration_beforeCharacterThe expiration date of the option contract. This will return options contracts with expiration dates before this date.[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  
next_pageCharacterGets the next page of data from a previous API call[optional]  


Return Type

object
IntrinioSDK::ApiResponseOptions

Properties

NameTypeDescription
optionsList of OptionA list of options contracts with the given symbol  
options_data_frameData FrameData frame representation of options
next_pageCharacterThe token required to request the next page of the data. If null, no further results are available.  
object
IntrinioSDK::Option

Properties

NameTypeDescription
idCharacterThe Intrinio ID for the Option.  
codeCharacterThe Intrinio Code for the Option.  
tickerCharacterThe ticker symbol of the Security for the Option.  
expirationCharacterThe date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
strikeNumericThe 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.  
typeCharacterThe 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.