Skip to contents

Get options data.

Usage

options_list(
  underlying_symbols,
  type = NULL,
  expiration_date_gte = NULL,
  expiration_date_lte = NULL,
  complete = FALSE
)

Arguments

type

Filter contracts by the type (`"call"` or `"put"`).

expiration_date_gte

Minimum expiration date.

expiration_date_lte

Maximum expiration date. By default this is set to the next weekend.

complete

Whether to retrieve complete chain with all future expiration dates.

Value

A data frame.

Examples

if (FALSE) { # \dontrun{
options("AAPL")
options("AAPL", "put")
} # }