historyFor: Retrieve history for a stock over chosen time-period as...

In schardtbc/iexcloudR: Wrapper for iexcloud Market Data Api

Description

Data Weighting:

Usage

historyFor(
  symbol,
  timePeriod = "1m",
  chartCloseOnly = FALSE,
  chartIEXOnly = FALSE,
  chartLastN = 0,
  chartInterval = 1,
  changeFromClose = FALSE,
  chartReset = FALSE,
  chartSimplify = FALSE,
  chartByDay = FALSE,
  date = ""
)

Arguments

symbol	stock symbol
timePeriod	is one of "dynamic" | "date" | "1d" | "5d" | "5dm" | "1m" | "1mm" | "3m" | "6m" | "ytd" | "1y" | "2y" | "5y | "max" 5dm returns five days at 10 minute intervals 1mm returns 1 month of data at 30 minute intervals max returns up to 15 years of end of day data for symbol
chartCloseOnly	= FALSE,(1 mu/minute 50 max.) All ranges except 1d. Will return adjusted data only with keys date, close, and volume.
chartIEXOnly	= FALSE,(free) Only for 1d. Limits the return of intraday prices to IEX only data.
chartLastN	= 0, If passed, chart data will return the last N elements
chartInterval	= 1,If passed, chart data will return every Nth element as defined by chartInterval
changeFromClose	= FALSE, If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
chartReset	= FALSE, If true, 1d chart will reset at midnight instead of the default behavior of 9:30am ET.
chartSimplify	= FALSE, If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts.
chartByDay	= FALSE, if TRUE and timeperiod is dte then will return end of day info for given date instead of minute bars,
date	as "YYYY-MM-DD"| "YYYYMMDD" | class(date) == "Date"

Details

• Adjusted + Unadjusted data: 10 message units per symbol per time interval returned (Excluding 1d) Example: If you query for AAPL 5 day, it will return 5 days of prices for AAPL for a total of 50.

• Adjusted close only data (chartCloseOnly=TRUE) 2 mu per symbol per time interval returned (Excluding 1d)

• Intraday minute bar data: 1 mu per symbol per time interval for 1d range up to a max of 50 Example: If you query for AAPL 1d at 11:00am, it will return 90 minutes of data for a total of 50.

• IEX Only intraday minute bar data (chartIEXOnly=TRUE): 0 mu (as in free) This will only return IEX data with keys minute, high, low, average, volume, notional, and numberOfTrades

Value

a dataframe

Examples

history("AAPL")

schardtbc/iexcloudR documentation built on Aug. 23, 2020, 3:58 a.m.