Skip to main content

Place Order

API to place an order to the exchange. The instrument_token required for the stock or contracts should be obtained from the BOD instruments.

Upon successfully placing the order with the exchange, a unique order_id is provided in the success response, which can be utilized for order modification or cancellation. If you intend to place an order outside of market hours, the 'is_amo' (After Market Order) should be set to 'true'. You can assign a tag(unique identifier) to your order, allowing you to retrieve orders associated with that tag using the Order History API.

NOTE

If you represent a business aiming to incorporate order flow management (including placing, canceling, and modifying orders), please visit the Uplink Business. The direct HTTP order placement API integration is intended for individual API users.

NOTE

Currently product type OCO is not allowed.


Header Parameters

NameRequiredTypeDescription
AuthorizationtruestringRequires the format Bearer access_token where access_token is obtained from the Token API.
Content-TypetruestringIndicates the media type of the resource, set as application/json.
AccepttruestringDefines the content format the client expects, which should be set to application/json.

Request Body

{
"quantity": 1,
"product": "D",
"validity": "DAY",
"price": 0,
"tag": "string",
"instrument_token": "NSE_EQ|INE848E01016",
"order_type": "MARKET",
"transaction_type": "BUY",
"disclosed_quantity": 0,
"trigger_price": 0,
"is_amo": false
}
NameRequiredTypeDescription
quantitytrueinteger (int32)Quantity with which the order is to be placed.
For commodity - number of lots is accepted.
For other Futures & Options and equities - number of units is accepted in multiples of the tick size.
producttruestringSignifies if the order was either Intraday or Delivery.
Possible values: I, D.
validitytruestringIt can be one of the following - DAY(default), IOC.
Possible values: DAY, IOC.
pricetruenumber (float)Price at which the order will be placed
tagfalsestringTag for a particular order
instrument_tokentruestringKey of the instrument. For the regex pattern applicable to this field, see the Field Pattern Appendix.
order_typetruestringType of order. It can be one of the following MARKET refers to market order LIMIT refers to Limit Order SL refers to Stop Loss Limit SL-M refers to Stop Loss Market.
Possible values: MARKET, LIMIT, SL, SL-M.
transaction_typetruestringIndicates whether its a buy or sell order.
Possible values: BUY, SELL.
disclosed_quantitytrueinteger (int32)The quantity that should be disclosed in the market depth
trigger_pricetruenumber (float)If the order is a stop loss order then the trigger price to be set is mentioned here
is_amotruebooleanSignifies if the order is an After Market Order
Responses

Response Body

{
"status": "success",
"data": {
"order_id": "1644490272000"
}
}
NameTypeDescription
statusstringA string indicating the outcome of the request. Typically success for successful operations.
dataobjectResponse data for place order request
data.order_idstringAn order ID for the order request placed

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...