Interface: Order
Single Order response.
Hierarchy
-
Order
Properties
average_price
average_price: number
Average price at which the order was executed (only for COMPLETE orders)
cancelled_quantity
cancelled_quantity: number
Quantity that's cancelled
disclosed_quantity
disclosed_quantity: number
Quantity to be disclosed (may be different from actual quantity) to the public exchange orderbook. Only for equities
exchange
exchange: string
Exchange
exchange_order_id
exchange_order_id: null | string
Exchange generated order ID. Orders that don't reach the exchange have null IDs
exchange_timestamp
exchange_timestamp: null | Date
Date at which the order was registered by the exchange. Orders that don't reach the exchange have null timestamps
exchange_update_timestamp
exchange_update_timestamp: null | string
Timestamp at which an order's state changed at the exchange
filled_quantity
filled_quantity: number
Quantity that's been filled
guid
guid: string
Unusable request id to avoid order duplication
instrument_token
instrument_token: number
The numerical identifier issued by the exchange representing the instrument. Used for subscribing to live market data over WebSocket
market_protection
market_protection: number
0 or 1
meta
meta: string | object
Map of arbitrary fields that the system may attach to an order.
order_id
order_id: string
Unique order ID
order_timestamp
order_timestamp: Date
Date at which the order was registered by the API
order_type
order_type: string
Order type (MARKET, LIMIT etc.)
parent_order_id
parent_order_id: null | string
Order ID of the parent order (only applicable in case of multi-legged orders like CO)
pending_quantity
pending_quantity: number
Pending quantity to be filled
placed_by
placed_by: string
ID of the user that placed the order. This may different from the user's ID for orders placed outside of Kite, for instance, by dealers at the brokerage using dealer terminals
price
price: number
Price at which the order was placed (LIMIT orders)
product
product: string
Margin product to use for the order (margins are blocked based on this) ?
quantity
quantity: number
Quantity ordered
status
status: string
Current status of the order. Most common values or COMPLETE, REJECTED, CANCELLED, and OPEN. There may be other values as well.
status_message
status_message: null | string
Textual description of the order's status. Failed orders come with human readable explanation
status_message_raw
status_message_raw: null | string
Raw textual description of the failed order's status, as received from the OMS
tag
tag: null | string
An optional tag to apply to an order to identify it (alphanumeric, max 20 chars)
tags
Optional tags: string[]
tradingsymbol
tradingsymbol: string
Exchange tradingsymbol of the of the instrument
transaction_type
transaction_type: string
BUY or SELL
trigger_price
trigger_price: number
Trigger price (for SL, SL-M, CO orders)
validity
validity: string
Order validity
variety
variety: string
Order variety (regular, amo, co etc.)