| Type: | Package |
| Title: | IEX Stocks and Market Data |
| Version: | 1.0.2 |
| Author: | Myriam Ibrahim [aut, cre] |
| Maintainer: | Myriam Ibrahim <ibrahimmyriam7@gmail.com> |
| URL: | https://github.com/TheEliteAnalyst/Riex |
| BugReports: | https://github.com/TheEliteAnalyst/Riex/issues |
| Description: | 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/). |
| Depends: | R (≥ 3.5.0), xts, zoo, TTR, tidyr, tibble |
| License: | GPL-2 |
| LazyData: | true |
| Collate: | 'IEX_Market_Data.R' |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.1.1 |
| Imports: | dplyr, ggplot2 (≥ 3.1.0), httr (≥ 1.4.0), purrr (≥ 0.2.5), rjson (≥ 0.2.20), stringr (≥ 1.3.1), urltools (≥ 1.7.1), quantmod (≥ 0.4-14) |
| Suggests: | knitr, rmarkdown, testthat |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2021-04-24 01:01:05 UTC; Myriam |
| Repository: | CRAN |
| Date/Publication: | 2021-04-24 12:10:10 UTC |
Returns quote for Crypto Currencies supported by the IEX Cloud API.
Description
For more details, visit:https://iexcloud.io/docs/api/#crypto
Usage
crypto(x, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Data frame that include Crypto currency financial details To retrieve list of 18 Cyrpto Currency Symbols available in IEX as of April 2019.
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
data(package = "Riex")
CrytoSymbols <- crypto_symbols
## End(Not run)
'IEX' Crypto currency symbols
Description
A List of 18 Cyrpto Currency Symbols available via IEX API v1 as of April 26, 2019. List subject to update. Please visit IEX Site for most current list https://iexcloud.io/docs/api/#reference-data IEX API version 1 will sunset non-Investors Exchange (IEX) data on June 1, 2019.
Usage
crypto_symbols
Format
A data frame with 18 rows and 1 variable:
- symbol
symbol, in ticker format
...
Source
https://iexcloud.io/docs/api/#cryptocurrency-symbols
'IEX' financials
Description
Returns income statement, balance sheet, and cash flow data from the most recent reported quarter. For more details, visit:https://iexcloud.io/docs/api/#financials
Usage
iex.cash.flow(x, iex_sk)
iex.balance.sheet(x, iex_sk)
iex.income(x, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Data frame with stock(s) financial data with option of selecting quarterly or annually
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.cash.flow("TSLA", "sk")
## End(Not run)
Account and usage details
Description
For more details, visit:https://iexcloud.io/docs/api/#account
Usage
iex.account(iex_sk)
iex.usage(iex_sk)
iex.key.usage(iex_sk)
iex.daily.usage(iex_sk)
iex.monthly.usage(iex_sk)
Arguments
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Most Active Stocks in IEX during the trading day
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Retrieves quote, bids, asks, trades and system event for each Stock Symbol
Description
For more details, visit:https://iexcloud.io/docs/api/#book
Usage
iex.book(x, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Details
for function like book(), only one value will be accepted per request
Value
Data frame with stock(s) quote data
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.book("TSLA", "sk")
## End(Not run)
Returns adjusted and unadjusted historical data for up to 15 years. Useful for building charts.
Description
For more details, visit:https://iexcloud.io/docs/api/#historical-prices
Usage
iex.chart(x, r, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
r |
An alpha numeric object that represents the time range selected. |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Data frame that includes stock (s) financial data
Note
r takes only of of the values accepted IN API request. "5y", "2y", "1y", "ytd", "6m", "3m", "1m", "1d"
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.chart("TSLA", "1y", "sk")
## End(Not run)
Returns company's key info. For example: Industry, CEO, website, number of employees, ..etc.
Description
For more details, visit:https://iexcloud.io/docs/api/#company
Usage
iex.company(x = "TSLA", iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
data frame with company summary data
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.company("TSLA", "sk")
## End(Not run)
Earnings data for a given company including the actual EPS, consensus, and fiscal period. Earnings are available quarterly (last 4 quarters)
Description
For more details, visit:https://iexcloud.io/docs/api/#earnings
Usage
iex.earnings(x, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Data frame that include earnings
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.earnings("TSLA", "sk")
## End(Not run)
Returns 1 minute bar data where open, high, low, and close are per minute. For latest stock price use the iex.quote function
Description
For more details, visit:https://iexcloud.io/docs/api/#historical-prices
Usage
iex.intraday(x, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Data frame that includes stock (s) financial data
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.intraday ("TSLA", "sk")
## End(Not run)
Returns the quotes for the top 10 most active symbols. Data scheduled for intraday update.
Description
For more details, visit:https://iexcloud.io/docs/api/#list
Usage
iex.most.active(iex_sk)
Arguments
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Most Active Stocks in IEX during the trading day
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Returns key stats per symbol - e.g. Market cap, 52 weeks high & low stock price
Description
For more details, visit:https://iexcloud.io/docs/api/#key-stats
Usage
iex.stats(x = "GM", iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Key statistics
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
iex.stats("TSLA", "sk")
## End(Not run)
Returns url for company's logo based on Google standardized APIs.
Description
For more details, visit:https://iexcloud.io/docs/api/#logo
Usage
logo(x, iex_sk)
Arguments
x |
A character vector that can include one or multiple Tickers / Stocks Symbols |
iex_sk |
is a character vector that include IEX Cloud API Secret Token |
Value
Company's Logo
Author(s)
Myriam Ibrahim
See Also
Investors Exchange 'IEX' developer guide https://iexcloud.io/docs/api/
Investors Exchange Group (IEX Group) offers flexible and salable pricing.https://iexcloud.io/pricing/
View Investors Exchange Group (IEX Group) terms of use and subscription levels.https://iexcloud.io/terms/
Package 'iexcloudR'https://github.com/schardtbc/iexcloudR
Examples
## Not run:
logo("GOOG", "sk")
## End(Not run)