api_instruments_options {RobinHood}

RobinHood API: Option Contracts

Description

Backend function or retrieving option contracts.

Usage

api_instruments_options(
  RH,
  method = "url",
  option_instrument_url = NULL,
  chain_symbol = NULL,
  type = NULL,
  state = NULL,
  strike_price = NULL,
  tradability = NULL,
  expiration_date = NULL
)

Arguments

RH

object of class RobinHood

method

(string) one of ("url", "symbol")

option_instrument_url

(string) direct url for an option contract

chain_symbol

(string) stock symbol

type

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

state

(string) one of ("active", "inactive")

strike_price

(numeric) strike price

tradability

(string) one of ("tradable", "untradable")

expiration_date

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