Skip to main content
Place a REAL limit order (production)

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string | null
required

Required, 1-64 characters. Per account: the same key with the same body replays the order.

Maximum string length: 64

Body

application/json
quantity
number
required

A weight in the symbol's measure (grams or kilograms), at most 4 decimal places.

Required range: x <= 1000000
symbol_code
string
required
Maximum string length: 32
trade_type
string
required

buy or sell.

trigger_price
number
required

Rupees per the symbol's quoted measure. A buy limit must be below the current buy price, a sell limit above the current sell price.

Required range: x <= 100000000
client_order_id
string | null
Maximum string length: 64

Response

Replay of an earlier request with the same key and body.

actions
string[]
required

edit and cancel while pending; else empty.

id
string
required
quantity
string
required
status
string
required

pending, confirming, triggered or cancelled.

status_detail
string
required

The desk's raw status: placing / cancelling read confirming.

symbol_code
string
required
total
string
required

The order's value at the trigger price, in rupees.

trade_type
string
required
trigger_price
string
required

Rupees, 2 decimals, as a string.

unit
string
required

g or kg.

blocked_reason
string | null

Why it would not execute if its price were reached now, or that it is confirming.

cancel_reason
string | null
client_order_id
string | null
created_at
string | null
environment
string
default:production
order_id
string | null

The market order a triggered limit became (see GET /orders); otherwise null.

source
string | null

api when placed through this API; null when placed in the app or on the web.