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 .

Prerequisites

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

Installation of the API package

First, clone the Intrinio R-SDK Github repo.

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

View R SDK on GitHub

Stock Price Code Example

Use my API Key

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

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

SecurityApi <- IntrinioSDK::SecurityApi$new(client)

# Required params

identifier <- "AAPL"

# Optional params

opts <- list(

start_date = as.Date("2018-01-01"),

end_date = as.Date("2019-01-01"),

frequency = "daily",

page_size = 100,

next_page = NULL

)

response <- SecurityApi$get_security_stock_prices(identifier, opts)

print(response)

print(response$content)

הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	Character	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
start_date	Date	Return prices on or after the date	[optional]
end_date	Date	Return prices on or before the date	[optional]
frequency	Character	Return stock prices in the given frequency	[optional] [default to daily]
page_size	Integer	The number of results to return	[optional] [default to 100]
next_page	Character	Gets the next page of data from a previous API call	[optional]

Return Type

object

IntrinioSDK::ApiResponseSecurityStockPrices

Properties

Name	Type	Description
stock_prices	List of StockPriceSummary	The stock prices for the Security
stock_prices_data_frame	Data Frame	Data frame representation of stock_prices
security	SecuritySummary	The Security resolved from the given identifier
next_page	Character	The token required to request the next page of the data. If null, no further results are available.

object

IntrinioSDK::StockPriceSummary

Properties

Name	Type	Description
date	Date	The calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)
intraperiod	Logical	If TRUE, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period
frequency	Character	The type of period that the stock price represents
open	Numeric	The price at the beginning of the period
high	Numeric	The highest price over the span of the period
low	Numeric	The lowest price over the span of the period
close	Numeric	The price at the end of the period
volume	Numeric	The number of shares exchanged during the period
adj_open	Numeric	The price at the beginning of the period, adjusted for splits and dividends
adj_high	Numeric	The highest price over the span of the period, adjusted for splits and dividends
adj_low	Numeric	The lowest price over the span of the period, adjusted for splits and dividends
adj_close	Numeric	The price at the end of the period, adjusted for splits and dividends
adj_volume	Numeric	The number of shares exchanged during the period, adjusted for splits and dividends
factor	Numeric	The factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.
split_ratio	Numeric	The ratio of the stock split, if a stock split occurred.
dividend	Numeric	The dividend amount, if a dividend was paid.
change	Numeric	The difference in price from the last price for this frequency
percent_change	Numeric	The percent difference in price from the last price for this frequency
fifty_two_week_high	Numeric	The 52 week high price (daily only)
fifty_two_week_low	Numeric	The 52 week low price (daily only)

object

IntrinioSDK::SecuritySummary

Properties

Name	Type	Description
id	Character	The Intrinio ID for Security
company_id	Character	The Intrinio ID for the Company for which the Security is issued
exchange	Character	The exchange's MIC
exchange_mic	Character	The security's exchange MIC
stock_exchange_id	Character	The exchange's Intrinio ID
name	Character	The name of the Security
code	Character	A 2-3 digit code classifying the Security (reference)
currency	Character	The currency in which the Security is traded on the exchange
ticker	Character	The common/local ticker of the Security
composite_ticker	Character	The country-composite ticker of the Security
figi	Character	The OpenFIGI identifier
composite_figi	Character	The country-composite OpenFIGI identifier
share_class_figi	Character	The global-composite OpenFIGI identifier
primary_listing	Logical	If TRUE, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

View Documentation for Stock Prices by Security Example

Release History

1.33.0

Released 02/26/2025

r-sdk-source-code-1.33.0.zip

1.32.0

Released 11/27/2024

r-sdk-source-code-1.32.0.zip

1.31.0

Released 11/21/2024

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

r-sdk-source-code-1.29.0.zip

1.28.0

Released 08/23/2024

r-sdk-source-code-1.28.0.zip

1.27.1

Released 08/10/2024

r-sdk-source-code-1.27.1.zip

1.27.0

Released 08/02/2024

r-sdk-source-code-1.27.0.zip

1.26.1

Released 07/22/2024

r-sdk-source-code-1.26.1.zip

1.26.0

Released 07/22/2024

r-sdk-source-code-1.26.0.zip

1.25.4

Released 06/25/2024

r-sdk-source-code-1.25.4.zip

1.25.3

Released 06/05/2024

r-sdk-source-code-1.25.3.zip

1.25.2

Released 04/10/2024

r-sdk-source-code-1.25.2.zip

1.25.0

Released 03/11/2024

r-sdk-source-code-1.25.0.zip

1.24.8

Released 02/20/2024

r-sdk-source-code-1.24.8.zip

1.24.7

Released 02/06/2024

r-sdk-source-code-1.24.7.zip

1.24.6

Released 02/01/2024

r-sdk-source-code-1.24.6.zip

1.24.5

Released 12/21/2023

r-sdk-source-code-1.24.5.zip

1.24.3

Released 12/05/2023

r-sdk-source-code-1.24.3.zip

1.24.2

Released 11/08/2023

r-sdk-source-code-1.24.2.zip

1.24.1

Released 10/03/2023

r-sdk-source-code-1.24.1.zip

1.24.0

Released 09/08/2023

r-sdk-source-code-1.24.0.zip

1.23.0

Released 08/01/2023

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

r-sdk-source-code-1.22.0.zip

1.21.1

Released 03/28/2023

r-sdk-source-code-1.21.1.zip

1.21.0

Released 03/17/2023

r-sdk-source-code-1.21.0.zip

1.20.5

Released 01/11/2023

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