Interfaces
OrderUpdatePostback

Interface: OrderUpdatePostback

Data returned on order_update event

Hierarchy

  • Order

    OrderUpdatePostback

Properties

average_price

average_price: number

Average price at which the order was executed (only for COMPLETE orders)

Inherited from

Order.average_price


cancelled_quantity

cancelled_quantity: number

Quantity that's cancelled

Inherited from

Order.cancelled_quantity


disclosed_quantity

disclosed_quantity: number

Quantity to be disclosed (may be different from actual quantity) to the public exchange orderbook. Only for equities

Inherited from

Order.disclosed_quantity


exchange

exchange: string

Exchange

Inherited from

Order.exchange


exchange_order_id

exchange_order_id: null | string

Exchange generated order ID. Orders that don't reach the exchange have null IDs

Inherited from

Order.exchange_order_id


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

Inherited from

Order.exchange_timestamp


exchange_update_timestamp

exchange_update_timestamp: null | string

Timestamp at which an order's state changed at the exchange

Inherited from

Order.exchange_update_timestamp


filled_quantity

filled_quantity: number

Quantity that's been filled

Inherited from

Order.filled_quantity


guid

guid: string

Unusable request id to avoid order duplication

Inherited from

Order.guid


instrument_token

instrument_token: number

The numerical identifier issued by the exchange representing the instrument. Used for subscribing to live market data over WebSocket

Inherited from

Order.instrument_token


market_protection

market_protection: number

0 or 1

Inherited from

Order.market_protection


meta

meta: string | object

Map of arbitrary fields that the system may attach to an order.

Inherited from

Order.meta


order_id

order_id: string

Unique order ID

Inherited from

Order.order_id


order_timestamp

order_timestamp: Date

Date at which the order was registered by the API

Inherited from

Order.order_timestamp


order_type

order_type: string

Order type (MARKET, LIMIT etc.)

Inherited from

Order.order_type


parent_order_id

parent_order_id: null | string

Order ID of the parent order (only applicable in case of multi-legged orders like CO)

Inherited from

Order.parent_order_id


pending_quantity

pending_quantity: number

Pending quantity to be filled

Inherited from

Order.pending_quantity


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

Inherited from

Order.placed_by


price

price: number

Price at which the order was placed (LIMIT orders)

Inherited from

Order.price


product

product: string

Margin product to use for the order (margins are blocked based on this) ?

Inherited from

Order.product


quantity

quantity: number

Quantity ordered

Inherited from

Order.quantity


status

status: string

Current status of the order. Most common values or COMPLETE, REJECTED, CANCELLED, and OPEN. There may be other values as well.

Inherited from

Order.status


status_message

status_message: null | string

Textual description of the order's status. Failed orders come with human readable explanation

Inherited from

Order.status_message


status_message_raw

status_message_raw: null | string

Raw textual description of the failed order's status, as received from the OMS

Inherited from

Order.status_message_raw


tag

tag: null | string

An optional tag to apply to an order to identify it (alphanumeric, max 20 chars)

Inherited from

Order.tag


tags

Optional tags: string[]

Inherited from

Order.tags


tradingsymbol

tradingsymbol: string

Exchange tradingsymbol of the of the instrument

Inherited from

Order.tradingsymbol


transaction_type

transaction_type: string

BUY or SELL

Inherited from

Order.transaction_type


trigger_price

trigger_price: number

Trigger price (for SL, SL-M, CO orders)

Inherited from

Order.trigger_price


validity

validity: string

Order validity

Inherited from

Order.validity


variety

variety: string

Order variety (regular, amo, co etc.)

Inherited from

Order.variety