IEX Stocks and Market Data

Retrieves efficiently and reliably Investors Exchange ('IEX') stock and market data using 'IEX Cloud API'. The platform is offered by Investors Exchange Group (IEX Group). Main goal is to leverage 'R' capabilities including existing packages to effectively provide financial and statistical analysis as well as visualization in support of fact-based decisions. In addition, continuously improve and enhance 'Riex' by applying best practices and being in tune with users' feedback and requirements. Please, make sure to review and acknowledge Investors Exchange Group (IEX Group) terms and conditions before using 'Riex' (< https://iexcloud.io/terms/>).


The main goal of ‘Riex’ is to efficiently retrieve financial and market data using ‘IEX Cloud API’. In addition, provide robust tool to:

  • Enable data analysis and visualization
  • Monitor Account usage and alerts

Please make sure to review and acknowledge IEX Terms of Use before using Riex.

Effective June 1st, 2019, Subscription will be required to access third party data.

For Subscriptions details, visit IEX - Flexible, scalable pricing.

  • Multiple tiers are available to users depending on their requirements with capability to upgrade
  • Usage is measured based on message counts which depends on API Call and associated weight
  • Example Company - API Call has a weight of 1 for each Symbol

Additional details about usage calculations available in Data Weight - section Best practice about storing and sharing Private & Publice Secret Key

Installation

You can install the released version of Riex from CRAN with:

install.packages("Riex")

Example

This is a basic example which shows you how to retrieve Company info via ‘IEX Cloud API’:

iex.company(x, iex_sk) requires 2 values:

  • x : A valid IEX Stock Symbol
  • iex_sk : ‘IEX Cloud API’ Secret Key. It is available to use via Account Console.

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

#Load Riex Package
library(Riex)
sk <- "[SECRET TOKEN]" 
x <- "TSLA"
TSLA_Co <- iex.company(x, sk)
TSLA_Co

For more details and additional examples, please review Riex vignette.

News

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("Riex")

1.0.1 by Myriam Ibrahim, 6 months ago


https://github.com/TheEliteAnalyst/Riex


Report a bug at https://github.com/TheEliteAnalyst/Riex/issues


Browse source code at https://github.com/cran/Riex


Authors: Myriam Ibrahim [aut, cre]


Documentation:   PDF Manual  


GPL-2 license


Imports dplyr, ggplot2, httr, purrr, rjson, stringr, tidyverse, urltools, quantmod

Depends on xts, zoo, TTR, tidyr, tibble

Suggests knitr, rmarkdown, testthat


See at CRAN