Learn R Programming

Riex

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 & Public 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.

Copy Link

Version

Install

install.packages('Riex')

Monthly Downloads

202

Version

1.0.2

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Myriam Ibrahim

Last Published

April 24th, 2021

Functions in Riex (1.0.2)

iex.chart

Returns adjusted and unadjusted historical data for up to 15 years. Useful for building charts.
crypto_symbols

`IEX` Crypto currency symbols
iex.account

Account and usage details
iex.most.active

Returns the quotes for the top 10 most active symbols. Data scheduled for intraday update.
iex.book

Retrieves quote, bids, asks, trades and system event for each Stock Symbol
iex.intraday

Returns 1 minute bar data where open, high, low, and close are per minute. For latest stock price use the iex.quote function
iex.company

Returns company's key info. For example: Industry, CEO, website, number of employees, ..etc.
financials

`IEX` financials
crypto

Returns quote for Crypto Currencies supported by the IEX Cloud API.
iex.stats

Returns key stats per symbol - e.g. Market cap, 52 weeks high & low stock price
iex.earnings

Earnings data for a given company including the actual EPS, consensus, and fiscal period. Earnings are available quarterly (last 4 quarters)
logo

Returns url for company's logo based on Google standardized APIs.