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
ZacksApi <- IntrinioSDK::ZacksApi$new(client)
# Optional params
opts <- list(
start_date = NULL,
end_date = NULL,
sales_actual_greater = NULL,
sales_actual_less = NULL,
sales_mean_estimate_greater = NULL,
sales_mean_estimate_less = NULL,
sales_amount_diff_greater = NULL,
sales_amount_diff_less = NULL,
sales_percent_diff_greater = NULL,
sales_percent_diff_less = NULL,
sales_count_estimate_greater = NULL,
sales_count_estimate_less = NULL,
sales_std_dev_estimate_greater = NULL,
sales_std_dev_estimate_less = NULL,
page_size = 100,
next_page = NULL
)
response <- ZacksApi$get_zacks_sales_surprises(opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
start_dateDateLimit sales surprises to those on or after this date[optional]  
end_dateDateLimit sales surprises to those on or before this date[optional]  
sales_actual_greaterNumericReturn only records with an actual sales higher than this value[optional]  
sales_actual_lessNumericReturn only records with an actual sales lower than this value[optional]  
sales_mean_estimate_greaterNumericReturn only records with a sales mean estimate greater than this value[optional]  
sales_mean_estimate_lessNumericReturn only records with a sales mean estimate lower than this value[optional]  
sales_amount_diff_greaterNumericReturn only records with a sales amount difference greater than this value[optional]  
sales_amount_diff_lessNumericReturn only records with a sales amount difference less than this value[optional]  
sales_percent_diff_greaterNumericReturn only records with a sales percent difference greater than this value[optional]  
sales_percent_diff_lessNumericReturn only records with a sales percent difference less than this value[optional]  
sales_count_estimate_greaterNumericReturn only records with a sales count estimate greater than this value[optional]  
sales_count_estimate_lessNumericReturn only records with a sales count estimate less than this value[optional]  
sales_std_dev_estimate_greaterNumericReturn only records with a sales standard deviation greater than this value[optional]  
sales_std_dev_estimate_lessNumericReturn only records with a sales standard deviation less than this value[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::ApiResponseZacksSalesSurprises

Properties

NameTypeDescription
sales_surprisesList of ZacksSalesSurpriseZacks Sales Surprise data for a Security in descending order by actual reported date  
sales_surprises_data_frameData FrameData frame representation of sales_surprises
next_pageCharacterThe token required to request the next page of the data. If null, no further results are available.  
object
IntrinioSDK::ZacksSalesSurprise

Properties

NameTypeDescription
idCharacterThe Intrinio ID for the record  
fiscal_yearNumericThe company's fiscal year for the reported period  
fiscal_quarterCharacterThe company's fiscal quarter for the reported period  
calendar_yearNumericThe closest calendar year for the company's fiscal year  
calendar_quarterCharacterThe closest calendar quarter for the company's fiscal year  
actual_reported_dateDateThe actual report date for the earnings release  
actual_reported_timeCharacterThe actual report time for the earnings release  
actual_reported_codeCharacterThe code cooresponding to the earnings release BTO = BEFORE THE OPENDTM = DURING THE MARKETAMC = AFTER MARKET CLOSE  
actual_reported_descCharacterThe description for the type of earnings release  
last_rev_dateDateThe last revision date for the analyst estimates  
sales_actualNumericThe actual Non-GAAP sales figure released by the company, interpreted by Zacks.  
sales_actual_zacks_adjNumericThe adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.  
sales_actual_gaapNumericThe actual GAAP sales figured released by the company  
sales_mean_estimateNumericThe pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts  
sales_amount_diffNumericThe sales surprise amount difference  
sales_percent_diffNumericThe sales surprise percent difference  
sales_std_dev_estimateNumericThe pre-earnings release standard deviation of sales estimates  
View Documentation for Zacks Sales Surprises 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