Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 3.84 KB

OrderBookData.md

File metadata and controls

79 lines (63 loc) · 3.84 KB
Raw

UpstoxClient.OrderBookData

Properties

Name Type Description Notes
exchange String Exchange to which the order is associated [optional]
product String Shows if the order was either Intraday, Delivery, CoverOrder or OneCancelsOther [optional]
price Number Price at which the order was placed [optional]
quantity Number Quantity with which the order was placed [optional]
status String Indicates the current status of the order. Valid order status’ are outlined in the table below [optional]
guid String [optional]
tag String Tag to uniquely identify an order [optional]
instrumentToken String Identifier issued by Upstox used for subscribing to live market quotes [optional]
placedBy String Uniquely identifies the user [optional]
tradingsymbol String Shows the trading symbol of the instrument [optional]
orderType String Type of order. It can be one of the following MARKET refers to market order<br>LIMIT refers to Limit Order<br>SL refers to Stop Loss Limit<br>SL-M refers to Stop loss market [optional]
validity String Order validity (DAY- Day and IOC- Immediate or Cancel (IOC) order) [optional]
triggerPrice Number If the order was a stop loss order then the trigger price set is mentioned here [optional]
disclosedQuantity Number The quantity that should be disclosed in the market depth [optional]
transactionType String Indicates whether the order was a buy or sell order [optional]
averagePrice Number Average price at which the qty got traded [optional]
filledQuantity Number The total quantity traded from this particular order [optional]
pendingQuantity Number Pending quantity to be filled [optional]
statusMessage String Indicates the reason when any order is rejected, not modified or cancelled [optional]
statusMessageRaw String Description of the order's status as received from RMS [optional]
exchangeOrderId String Unique order ID assigned by the exchange for the order placed [optional]
parentOrderId String In case the order is part of the second or third leg of a CO or OCO, the parent order ID is indicated here [optional]
orderId String Unique order ID assigned internally for the order placed [optional]
variety String Order complexity [optional]
orderTimestamp String User readable timestamp at which the order was placed [optional]
exchangeTimestamp String User readable time at which the order was placed or updated [optional]
isAmo Boolean Signifies if the order is an After Market Order [optional]
orderRequestId String Apart from 1st order it shows the count of how many requests were sent [optional]
orderRefId String The order reference ID for which the order must be modified [optional]

Enum: ExchangeEnum

  • NSE (value: "NSE")
  • NFO (value: "NFO")
  • CDS (value: "CDS")
  • BSE (value: "BSE")
  • BCD (value: "BCD")
  • BFO (value: "BFO")
  • MCX (value: "MCX")

Enum: ProductEnum

  • I (value: "I")
  • D (value: "D")
  • CO (value: "CO")
  • OCO (value: "OCO")
  • MTF (value: "MTF")

Enum: OrderTypeEnum

  • MARKET (value: "MARKET")
  • LIMIT (value: "LIMIT")
  • SL (value: "SL")
  • SL_M (value: "SL-M")

Enum: ValidityEnum

  • DAY (value: "DAY")
  • IOC (value: "IOC")

Enum: TransactionTypeEnum

  • BUY (value: "BUY")
  • SELL (value: "SELL")