NEWS

Riex 1.0.2 (2021-04-24)

Enhancements

'tidyverse' package removed from DESCRIPTION file per Hadley Wickham suggestion to improve performance and avoid future potential issues
Vignette updated

Bug fixes

iex.company(x,iex_sk) has been modified to resolve error for address field with NULL value (#3, #6)
Financials functions - e.g.Cash Flow, Income Statement have been modified to resolve error due to change in IEX API output for paid subscriptions(#4)
iex.chart(x,r, iex_sk) has been modified to resolve issue with output format (#8)

Riex 1.0.1 (2019-05-05)

I'm excited to announce that Riex package is now available on CRAN! and you can install using:

install.packages("Riex")

Introduction

Main purpose of RIEX is to efficiently and reliably retrieve stocks and market data via IEX Cloud API. Platform is offered by Investors Exchange Group - IEX Group. To subscribe, visit: IEX Cloud

First Riex release includes basic functions that retrieve data in a standard format - e.g. Data frames. Future releases are expected to:

Leverage R capabilities including existing packages to effectively provide financial and statistical analysis as well as visualization.
Use Reticuate - an R package that interface with Python modules, classes and functions to further enhance the capability to process and analyze data.
Optimize code to retrieve data for multiple symbols.

Get Started

Secret Key/ Token is required for all API callS. It is available via Account Console and assigned the variable sk in the documentation. e.g. sk <- "sk_...".

Keep your Secret Token safe. Your Secret Token can make any API call on behalf of your account, including changes that may impact billing such as enabling pay-as-you-go charges.

For more details about best practices to store and encrypt Secret Key/ Token check httr package | Managing secrets by Hadley Wickham

Load Package

library(Riex)

Assign valid values to key parameters:

sk <- "[SECRET KEY]". e.g. sk <- "sk_..."
x <- "TSLA"
r <- "1y"

Examples

Account usage details

iex.key.usage()

usage <- iex.key.usage(sk)
print(usage)

Time series - OHLC

TSLA <- iex.chart(x, r, sk)

Use quantmod package for visualization

library(quantmod)

Generate Barchart

barChart(TSLA)

To check available themes to customize visualization

names(quantmod:::.chart.theme)

To apply a different Theme

barChart(TSLA, theme="white")

chartSeries(TSLA)

To create an interactive chart for multiple stocks

Credit: Chris Bow

Retrieve OHLC data

TSLA <- iex.chart("TSLA", r, sk)

GM <- iex.chart("GM", r, sk)

To view top records in time series for TSLA

head(TSLA)

Merge data for both stocks

stocks <- cbind(TSLA$Close, GM$Close)

Change columns names to specify close by symbol

colnames(stocks) <- paste0(c("TSLA", "GM"), ".Close")

Load the following packages

library(dygraphs)

library(dplyr)

Get the first and last date

start(stocks)

[1] "2018-05-16"

end(stocks)

[1] "2019-05-15"

Setup chart

stocks_chart <- dygraph(stocks, main = "TSLA & GM Closing Price - 1 Year") %>%
  dySeries("GM.Close", axis = "y2") %>% 
  dyAxis("y", 
         label = "TSLA") %>%
  dyAxis("y2", 
         label = "GM",
         valueRange = c(20, 50),
         independentTicks = TRUE) %>%
  dyRangeSelector(dateWindow = c("2018-05-16", "2019-05-15")) %>%
  dyRoller()

Display Chart in Viewer pane

stocks_chart

To save in html format and display in browser, following are the steps:

Install and load htmlwidgets

install.packages("htmlwidgets")

library(htmlwidgets)

saveWidget(stocks_chart, 
           "stocks_chart.html",
           selfcontained = TRUE)

Conclusion

IEX Group mission "We're building fairer markets." is the motivation for this project and certainly hope to continue supporting their effort and bring value to the community. There has been significant enhancements since launching IEX Cloud API which makes this project really exciting!!

Your feedback and suggestions will be key to continuously improve Riex so it becomes relevant and practical to use. Please provide feedback and report any issues on GitHub.