Skip to main content

Authorizations

X-API-Key
string
header
required

Path Parameters

limit_order_id
string
required

Body

application/json

A new trigger price, a new quantity, or both. Nothing else is editable.

quantity
number | null
Required range: 0 < x <= 1000000
trigger_price
number | null
Required range: 0 < x <= 100000000

Response

Successful Response

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.