R (R Core Team 2019) package converts Intrinio (Swagger Codegen community 2020) objects and lists to dataframes.
The Project
This project has been created as part of UBC’s Master of Data Science Program. Information about the contributors can be found here. The Code of Conduct can be found here. The collaboration expectations regarding use of Github Flow can be found here.
If you were to search the web for “historical stock data”, or “financial statement data”, the results you would come across would be a variety of web applications (such as Google Finance), and maybe some PDFs of financial statements. This is fair, as there is a massive volume of stock data, and financial statements require lots of discretion (including standards followed - US companies may choose between reporting under IFRS and US GAAP). Intrinio offers solutions to this problem with an API platform that can easily be used to extract data and perform further analysis on it.
Intrinio is an excellent source to get data into the R environment to analyse data, but a problem persists that the data can’t be directly analysed from Intrinio objects. That is where rintrinio comes in. This package will offer a variety of functions that allow users to seamlessly transform Intrinio objects into dataframes. This will enable users of the data to make the most of Intrinio’s reliable and easy-to-use API platform, as well as the analysis capabilities that are available in R’s environment.
rintrinio in the R Ecosystem
R is an object-oriented programming language, which has allowed contributors of packages to make complex data types appear simple, and overall make packages easy for users to use. R’s native dataframe object is extremely popular and widely accepted in the R ecosystem. Intrinio’s API platform for R actually has a function that is supposed to return the results as a dataframe object, but it is actually a list that is returned. This package will transform Intrinio objects into dataframes that will make this data ready for the end user to use.
Coverage
To get the line coverage, run the following command line code :
Dependencies
Getting an API Key
Before using any functions included in this package, you must sign up for an appropriate Intrinio account. Once you have signed up for the appropriate account, you can find your API key (which is a required argument in all functions) by doing the following:
- In the top right corner, select
My Account - In the left hand menu, select
API KEYS - Copy your relevant API Key. Note that this is unique to you and should not be shared.
If you are using a free version of Intrinio for educational purposes, please note that you will only have access to the Developer Sandbox so use that API key in functions.
Installing Intrinio R SDK
Please note that the Intrinio R SDK is not available via CRAN. To install, follow these steps, as outlined in the Intrinio R Documentation.
In an R console, install devtools if it is not already installed:
Clone the Intrinio R SDK Github Repository:
Set your working directory to where you cloned the Intrinio R SDK Github Repository and install the IntrinioSDK package via the R console:
Usage
library(rintrinio)
library(dplyr)
#>
#> Attaching package: 'dplyr'
#> The following objects are masked from 'package:stats':
#>
#> filter, lag
#> The following objects are masked from 'package:base':
#>
#> intersect, setdiff, setequal, union
# Gather Financial Statement Time Series Function
gather_financial_statement_time_series(api_key = api_key,
ticker = 'AAPL',
statement = 'balance_sheet_statement',
year = c("2018", "2019"),
period = c('Q1')) %>%
filter(type == "year" | type == "cashandequivalents")
#> Warning: Column `type` joining factors with different levels, coercing to
#> character vector
#> type fin_value fin_value.
#> 1 year 2018 2019
#> 2 cashandequivalents 2.7491e+10 4.4771e+10
# Gather Financial Statement Cross-Company Comparison Function
gather_financial_statement_company_compare(api_key = api_key,
ticker = c("AAPL", "CSCO"),
statement = "income_statement",
year = "2019",
period = "Q1") %>%
filter(name == "ticker" | name == "sgaexpense")
#> Warning: Column `name` joining factors with different levels, coercing to
#> character vector
#> name value.x value.y
#> 1 ticker AAPL CSCO
#> 2 sgaexpense 4.783e+09 2.11e+08
# Gather Stock Price Time Series Function
gather_stock_time_series(api_key = api_key,
ticker = "CSCO",
start_date = "2020-02-01",
end_date = "2020-02-05") %>%
select(date, low, high)
#> date low high
#> 1 2020-02-05 48.15 48.6000
#> 2 2020-02-04 47.11 47.7074
#> 3 2020-02-03 46.21 46.8250
# Gather Stock Returns Function
gather_stock_returns(api_key = api_key,
ticker = c("AAPL", "CSCO"),
buy_date = "2019-01-01",
sell_date = "2020-01-01")
#> Stock Buy.date Buy.price Sell.date Sell.price Return....
#> 1 AAPL 2019-01-02 155.2140 2019-12-31 292.9547 88.74
#> 2 CSCO 2019-01-02 41.4651 2019-12-31 47.6100 14.82Functions
- gather_financial_statement_time_series(): This function takes in a single stock ticker symbol, the statement, the year, and a vector of various periods to compare. It returns a data frame of the information in the selected statement, for a time-series analysis of the company specified.
- gather_financial_statement_company_compare(): This function takes in a vector containing the tickers of the companies we want to compare, the statement we want to focus on, and the year and the period of the year we want to study. It returns a dataframe of the information in the selected statement, for the selected companies at the wanted time.
- gather_stock_time_series(): This function takes in a single stock ticker symbol and returns historical stock price data from a timeframe, returned as a dataframe.
- gather_stock_returns(): This function takes in multiple stock ticker symbols, buy-in date, sell-out date and returns a dataframe containing the historical prices at buy-in and sell-out date as well as the corresponding returns (profit/loss).
