Interface Order

Order placed by the user in the current trading day.


  • Order


clientId: string

The client id of the fyers user.

currentPrice: number

Last price of symbol.

date: string

The order time as per DD-MMM-YYYY hh:mm:ss in IST.

description?: string

Short name for the symbol Eg: “SBIN-EQ”.

disclosedQuantity: number

Disclosed quantity.

exchange: Exchange

The exchange in which order is placed.

id: string

The order id assigned for each order.

instrument: InstrumentType

Exchange instrument type.

limitPrice: number

The limit price for the order.

message: string

The error messages are shown here.

name: string

The name of symbol for which order is placed.

offline: boolean

True when placing AMO order.

pan: string

PAN of the client.

parentId?: string

The parent order id will be provided only for applicable orders.

priceChange: number

Price change from previous trading day.

priceChangePercent: number

Percent price change from previous trading day.

productType: ProductType

The product type.

quantity: number

The original order qty.

remainingDisclosedQuantity: number

Remaining disclosed quantity.

remainingQuantity: number

The remaining qty.

segment: Segment

The segment this order is placed in.

side: OrderSide

The order is buy or sell.

source: OrderSource

Source from where the order was placed.

status: OrderStatus

The status of the order.

stopPrice: number

The stop price for the order.

symbol: string

The symbol for which order is placed.

token: string

A unique identifier for every symbol.

tradedPrice: number

The average traded price for the order.

tradedQuantity: number

The filled qty after partial trades.

type: OrderType

The type of order.

validity: OrderValidity

Day or IOC.

Generated using TypeDoc