https://github.com/theeliteanalyst/riex

Riex
https://github.com/theeliteanalyst/riex

finance financial-analysis financial-data iex iex-api iexcloud r

Last synced: 3 months ago
JSON representation

Riex

• Host: GitHub
• URL: https://github.com/theeliteanalyst/riex
• Owner: TheEliteAnalyst
• Created: 2019-05-03T15:30:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-04-25T01:55:54.000Z (over 4 years ago)
• Last Synced: 2025-10-22T03:55:43.076Z (3 months ago)
• Topics: finance, financial-analysis, financial-data, iex, iex-api, iexcloud, r
• Language: R
• Homepage:
• Size: 1.17 MB
• Stars: 9
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.Rmd
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# Riex

[![Travis build status](https://travis-ci.com/TheEliteAnalyst/Riex.svg?branch=master)](https://travis-ci.com/TheEliteAnalyst/Riex)

![Version](https://img.shields.io/github/r-package/v/theeliteanalyst/riex)

![License](https://img.shields.io/cran/l/Riex)

![Open issues](https://img.shields.io/github/issues-raw/theeliteanalyst/riex?color=red)

![Closed issues](https://img.shields.io/github/issues-closed-raw/theeliteanalyst/riex?color=success)

![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FTheEliteAnalyst)

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](https://iexcloud.io/terms/) before using Riex.

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

For Subscriptions details, visit [IEX - Flexible, scalable pricing](https://iexcloud.io/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](https://iexcloud.io/docs/api/#company) has a weight of 1 for each Symbol

Additional details about usage calculations available in [Data Weight - section](https://iexcloud.io/docs/api/#how-credits-work)

Best practice about storing and sharing [Private & Public Secret Key](https://iexcloud.io/docs/api/#authentication)

## Installation

You can install the released version of Riex from [CRAN](https://CRAN.R-project.org) with:

``` r

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

```r

#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.