place_order_options: Place a options buy or sell order against your RobinHood...

View source: R/place_order_options.R

place_order_optionsR Documentation

Place a options buy or sell order against your RobinHood account

Description

Place an order on an option contract. Currently only limit orders are supported so you must supply a price

Usage

place_order_options(
  RH,
  option_id,
  direction,
  side,
  quantity,
  stop_price = NULL,
  type = "limit",
  time_in_force
)

Arguments

RH

object of class RobinHood

option_id

(string) id returned from get_contracts()

direction

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

side

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

quantity

(integer) number of contracts to buy

stop_price

(numeric) stop price for a limit order

type

(string) "limit" or "market" (only limit is currently supported)

time_in_force

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

Examples

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

# Place an options order, should generate an email confirmation
x <- place_order_options(RH = RH,
                       option_id = "346e46af-380e-4052-a7c2-15748f0fc0ca",
                       direction = "debit",   # one of "debit" or "credit"
                       side = "buy",          # one of "buy" or "sell"
                       quantity = 1,          # number of contracts
                       stop_price = .01,      # Time period (gfd: good for day)
                       type = "limit",        # limit or market (only limit is currently supported)
                       time_in_force = "gtc") # "gfd", "gtc", "ioc", "opg"

## End(Not run)

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