Option Prices

Option Prices R API Documentation

Returns all price data from inception to expiration for a particular contract.

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

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
identifier <- "MSFT190405C00118000"
# Optional params
opts <- list(
start_date = "2019-01-01",
end_date = "2019-12-31",
page_size = 100,
next_page = NULL
)
response <- OptionsApi$get_options_prices(identifier, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierCharacterThe Intrinio ID or code of the options contract to request prices for. 
start_dateCharacterReturn option contract prices on or after this date.[optional]  
end_dateCharacterReturn option contract prices on or 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::ApiResponseOptionPrices

Properties

NameTypeDescription
pricesList of OptionPriceA list of option prices in descending order by date  
prices_data_frameData FrameData frame representation of prices
optionOption 
next_pageCharacterThe token required to request the next page of the data. If null, no further results are available.  
object
IntrinioSDK::OptionPrice

Properties

NameTypeDescription
dateCharacterThe date of the price, in the format YYYY-MM-DD  
closeNumericThe closing price of the options contract.  
close_bidNumericThe closing bid price of the options contract.  
close_askNumericThe 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_volatilityNumericThe 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_changeNumericThe change in implied volatility for that day.  
deltaNumericDelta 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.  
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.