api_orders_options: RobinHood API: Option Orders

View source: R/api_orders_options.R

api_orders_optionsR Documentation

RobinHood API: Option Orders

Description

RobinHood API: Option Orders

Usage

api_orders_options(
  RH,
  action,
  status_url = NULL,
  cancel_url = NULL,
  quantity = NULL,
  direction = NULL,
  stop_price = NULL,
  type = NULL,
  time_in_force = NULL,
  side = NULL,
  option_id = NULL
)

Arguments

RH

object of class RobinHood

action

(string) one of "order", "status", "cancel", "history"

status_url

(string) if action = "status", status_url is required (output from place_order_options())

cancel_url

(string) if action = "cancel", cancel_url is required (output from place_order_options())

quantity

(int) number of contracts you want to buy

direction

(string) one of "debit" or "credit"

stop_price

(numeric) stop price on a limit order

type

(string) one of "limit" or "market"

time_in_force

(string) Good Till Canceled ("gtc"), Immediate or Cancel ("ioc"), or Opening ("opg")

side

(string) one of "buy" or "sell"

option_id

(string) id column returned by get_contracts()


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