R SDK

  1.33.0

The Intrinio R SDK wraps all API endpoints into an easy-to-use set of classes, methods, and response objects.

R SDK Installation

The new Intrinio R SDK is not yet available via CRAN and must be installed manually.

Once the new Intrinio R SDK reaches version 1.0.0 it will be uploaded to and made available via CRAN, superseding the current Intrinio Stock API Wrapper .

R Studio installed using the Anaconda Navigator may not be able to install the necessary dependencies, due to compilation restrictions

Prerequisites

You'll need the devtools package in order to build the API. Install the devtools package with the following command in R:

> R
> if(!require(devtools)) { install.packages("devtools") }

Installation of the API package

First, clone the Intrinio R-SDK Github repo.

> git clone https://github.com/intrinio/r-sdk.git

Next, set your working directory to where you've cloned the R SDK and using R, execute:

> cd r-sdk
> R
> library(devtools)
> install(".")
View R SDK on GitHub

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 <- "AAPL__261218C00230000"
# Optional params
opts <- list(
source = NULL,
stock_price_source = NULL,
model = NULL,
show_extended_price = NULL
)
response <- OptionsApi$get_options_prices_realtime(identifier, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierCharacterThe Intrinio ID or code of the options contract to request prices for. 
sourceCharacterRealtime or 15-minute delayed contracts.[optional]  
stock_price_sourceCharacterSource for underlying price for calculating Greeks.[optional]  
modelCharacterModel for calculating Greek values. Default is black_scholes.[optional]  
show_extended_priceLogicalWhether to include open close high low type fields.[optional]  


Return Type

object
IntrinioSDK::ApiResponseOptionsPriceRealtime

Properties

NameTypeDescription
priceOptionPriceRealtime 
statsOptionStatsRealtime 
optionOptionRealtime 
extended_priceOptionPriceRealtimeExtended 
object
IntrinioSDK::OptionPriceRealtime

Properties

NameTypeDescription
lastNumericThe price of the last trade  
last_sizeIntegerThe size of the last trade  
last_timestampPOSIXltThe time of the last trade  
volumeIntegerThe cumulative volume of this options contract that traded that day.  
askNumericThe price of the top ask order  
ask_sizeIntegerThe size of the top ask order  
ask_timestampPOSIXltThe timestamp of the top ask order  
bidNumericThe price of the top bid order  
bid_sizeIntegerThe size of the top bid order  
bid_timestampPOSIXltThe time of the top bid order  
open_interestIntegerThe total number of this options contract that are still open.  
exercise_styleCharacterThe exercise style of the option. ("A" = "American", "E" = "European")  
object
IntrinioSDK::OptionStatsRealtime

Properties

NameTypeDescription
implied_volatilityNumericThe implied volatility of the contract calculated using the Black-Scholes Model.  
deltaNumericDelta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
gammaNumericGamma represents the rate of change between an option's delta and the underlying asset's price.  
thetaNumericTheta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
vegaNumericVega represents the rate of change between an option's value and the underlying asset's implied volatility.  
underlying_priceNumericThe most recent trade price of the underlying asset.  
object
IntrinioSDK::OptionRealtime

Properties

NameTypeDescription
codeCharacterThe Intrinio Code for the Option.  
tickerCharacterThe 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.  
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).  
object
IntrinioSDK::OptionPriceRealtimeExtended

Properties

NameTypeDescription
bid_openNumericThe price of the bid at open  
bid_highNumericThe high bid so far today  
bid_lowNumericThe low bid so far today  
ask_openNumericThe price of the ask at open  
ask_highNumericThe high ask so far today  
ask_lowNumericThe low ask so far today  
trade_openNumericThe price of the trade at open  
trade_highNumericThe high trade so far today  
trade_lowNumericThe low trade so far today  
ask_closeNumericThe price of ask at close today  
bid_closeNumericThe price of bid at close today  
trade_closeNumericThe price of the last trade of the day  
markNumericThe mark price  
View Documentation for Option Prices Realtime Example

Release History

1.33.0

Released 02/26/2025

No release notes for this build.

r-sdk-source-code-1.33.0.zip

1.32.0

Released 11/27/2024

No release notes for this build.

r-sdk-source-code-1.32.0.zip

1.31.0

Released 11/21/2024

No release notes for this build.

r-sdk-source-code-1.31.0.zip

1.30.0

Released 10/31/2024
r-sdk-source-code-1.30.0.zip

1.29.0

Released 09/19/2024

Added stock exchange quote endpoint

r-sdk-source-code-1.29.0.zip

1.28.0

Released 08/23/2024

Fix type on one endpoint.
Add quote type fields to equity intervals.

r-sdk-source-code-1.28.0.zip

1.27.1

Released 08/10/2024

No release notes for this build.

r-sdk-source-code-1.27.1.zip

1.27.0

Released 08/02/2024

Quote endpoint
Allow certain endpoints to specify multiple tickers

r-sdk-source-code-1.27.0.zip

1.26.1

Released 07/22/2024

Added bid and ask timestamp properties for equities realtime price quotes.

r-sdk-source-code-1.26.1.zip

1.26.0

Released 07/22/2024

No release notes for this build.

r-sdk-source-code-1.26.0.zip

1.25.4

Released 06/25/2024

No release notes for this build.

r-sdk-source-code-1.25.4.zip

1.25.3

Released 06/05/2024

No release notes for this build.

r-sdk-source-code-1.25.3.zip

1.25.2

Released 04/10/2024

Advanced Company News endpoints

r-sdk-source-code-1.25.2.zip

1.25.0

Released 03/11/2024

No release notes for this build.

r-sdk-source-code-1.25.0.zip

1.24.8

Released 02/20/2024

Added Zacks Sales Estimates endpoint.

r-sdk-source-code-1.24.8.zip

1.24.7

Released 02/06/2024

No release notes for this build.

r-sdk-source-code-1.24.7.zip

1.24.6

Released 02/01/2024

No release notes for this build.

r-sdk-source-code-1.24.6.zip

1.24.5

Released 12/21/2023

Add extended price fields to options realtime calls
Add bid/ask time and size to options eod calls

r-sdk-source-code-1.24.5.zip

1.24.3

Released 12/05/2023

Documentation updates and fixes

r-sdk-source-code-1.24.3.zip

1.24.2

Released 11/08/2023

-Adjusting and releasing Company Public Float endpoint.

r-sdk-source-code-1.24.2.zip

1.24.1

Released 10/03/2023

Added missing preexisting parameters to SDK methods.

r-sdk-source-code-1.24.1.zip

1.24.0

Released 09/08/2023

Add extra hint message to a Trade Alerts endpoint if user doesn’t have access
Fix enum on depreciated intraday endpoint docs
Add date filters to shares outstanding endpoint
Allow either datetime format for param on snapshot endpoints
Add missing next page param to docs for institutional ownership endpoint
Add documentation for market status endpoint

r-sdk-source-code-1.24.0.zip

1.23.0

Released 08/01/2023

Can specify greeks underlying price source in some options calls
Can specify greeks IV method of calculation in some options calls
Update intervals syntax so it can pull from more performant source

r-sdk-source-code-1.23.0.zip

1.22.1

Released 07/12/2023
r-sdk-source-code-1.22.1.zip

1.22.0

Released 06/14/2023

No release notes for this build

r-sdk-source-code-1.22.0.zip

1.21.1

Released 03/28/2023

Added a next_page param in the SDK for an options endpoint where it already exists.

r-sdk-source-code-1.21.1.zip

1.21.0

Released 03/17/2023

Added interval and movers endpoints.

r-sdk-source-code-1.21.0.zip

1.20.5

Released 01/11/2023

Added options intervals and equitites delayed SIP endpoints
Added Intervals Movers endpoints

r-sdk-source-code-1.20.5.zip

1.20.4

Released 09/19/2022
r-sdk-source-code-1.20.4.zip

1.20.3

Released 09/17/2022
r-sdk-source-code-1.20.3.zip