place_order: Function to place a trade.

Description Usage Arguments Details Value See Also

View source: R/restful.R

Description

Function to place a trade with specified details.

Usage

1
2
3
4
5
place_order(object, exchange, tradingsymbol, transaction_type, quantity,
  order_type = ORDER_TYPE_MARKET, variety = VARIETY_REGULAR,
  product = PRODUCT_NRML, price = NULL, validity = NULL,
  disclosed_quantity = NULL, trigger_price = NULL, squareoff = NULL,
  stoploss = NULL, trailing_stoploss = NULL, tag = NULL)

Arguments

object

An object of type kite connect with valid api_key and access_token.

exchange

Exchange for the order, e.g. NSE, NFO, CDS etc.

tradingsymbol

Trading Symbol of the instrument.

transaction_type

BUY or SELL.

quantity

Quantity of the order.

order_type

Order type, e.g. MARKET, LIMIT, SL or SL-M.

variety

Order variety, e.g. regular, bo, co or amo.

product

Product type, e.g. MIS, NRML, CNC, BO or CO.

price

Price if required (e.g. for limit orders).

validity

Validity period of the order (DAY/IOC), defaults to DAY.

disclosed_quantity

Quantity to disclosed publicly.

trigger_price

Trigger price if required (e.g. for stop loss orders).

squareoff

Price difference for profit booking (bracker orders).

stoploss

Price difference for loss booking (bracket orders).

trailing_stoploss

Trailing stop loss (for bracket orders).

tag

Optional string to tag an order (alphanumeric, max 8 chars).

Details

This function sends an order with input details for execution. Please note not all parameters are relevant for all types of orders. This function (as with rest of the package) does no error checks and post the trade request as is. It is left to the function calling this method to carry out necessary error checks. If the order is successfully posted, an order ID will be returned. A successfully posted order does not mean it is a valid order, and orders with erroneous user input can be immedeately cancelled. Therefore it is good practice to check the order details once an order ID is received from this call.

Value

Returns an order ID (string), if successful.

See Also

order_history

modify_order

cancel_order


prodipta/kiteconnect3 documentation built on Sept. 24, 2020, 8:30 a.m.