get_historicals_options: Get historical options from RobinHood

View source: R/get_historicals_options.R

get_historicals_optionsR Documentation

Get historical options from RobinHood

Description

Returns a data frame of historical options for a given symbol, strike price, and expiration date.

Usage

get_historicals_options(
  RH,
  chain_symbol,
  type,
  strike_price,
  expiration_date,
  interval = NULL,
  span = NULL
)

Arguments

RH

object of class RobinHood

chain_symbol

(string) stock symbol

type

(string) one of ("put", "call")

strike_price

(numeric) strike price

expiration_date

(string) expiration date (YYYY-MM-DD)

interval

(string) one of ("5minute", "10minute", "hour", "day", "week")

span

(string) one of ("day", "week", "month")

Examples

## Not run: 
# Login in to your RobinHood account
RH <- RobinHood("username", "password")

get_historicals_options(RH = RH, chain_symbol = "AAPL", interval = "10minute", type = "call",
                        expiration_date = "2021-03-12", strike_price = 122)


## End(Not run)

RobinHood documentation built on Jan. 7, 2023, 1:11 a.m.