General Socket - Order Events

This WebSocket allows you to receive live updates on the status of your orders, including partial fills and rejections.

USE CASE

Receive an update the moment one of your orders is placed, modified, traded or rejected.

Details

The WebSocket API for receiving order, position, trade, price alerts, and EDIS updates is a real-time communication protocol designed to provide seamless access to various critical elements of a trading and EDIS system. This API allows traders and developers to establish a persistent, bidirectional connection with the server, enabling them to receive real-time updates on their orders, current positions, executed trades, price alerts, and EDIS status.
Subscribe with the orders action on the raw socket, or OnOrders in the Python SDK (callback on_orders). Nothing is delivered until you subscribe.
Match each update to your order with id. exchOrdId is the exchange order id and id_fyers is the FYERS-generated unique identifier.
Read status to track the order: 1 canceled, 2 traded, 4 transit, 5 rejected, 6 pending, 7 expired (3 is not used). message carries error text.
filledQty and remainingQuantity show how much has traded and what is left after partial trades. tradedPrice is the average traded price.
offlineOrder is true for an AMO order and false when the market is open. parentId is sent only for orders where it applies.
orderDateTime is in IST as DD-MMM-YYYY hh:mm:ss, for example 04-Aug-2023 10:12:58.
The raw socket message uses different key names. The SDK renames them, for example org_ord_status to status and qty_remaining to remainingQuantity. See the key mappers on General WebSocket - Subscribe.

Response Attributes - For order updates

Attribute	Data Type	Description
`id`	string	The unique order id assigned for each order
`exchOrdId`	string	The order id provided by the exchange
`symbol`	string	The symbol for which order is placed
`qty`	int	The original order qty
`remainingQuantity`	int	The remaining qty
`filledQty`	int	The filled qty after partial trades
`status`	int	1 => Canceled 2 => Traded / Filled 3 => (Not used currently) 4 => Transit 5 => Rejected 6 => Pending 7 => Expired View Details
`message`	string	The error messages are shown here
`segment`	int	10 => E (Equity) 11 => D (F&O) 12 => C (Currency) 20 => M (Commodity) View Details
`limitPrice`	float	The limit price for the order
`stopPrice`	float	The limit price for the order
`productType`	string	The product type
`type`	int	1 => Limit Order 2 => Market Order 3 => Stop Order (SL-M) 4 => Stoplimit Order (SL-L)
`side`	int	1 => Buy -1 => Sell View Details
`orderValidity`	string	DAY IOC
`orderDateTime`	string	The order time as per DD-MMM-YYYY hh:mm:ss in IST
`parentId`	string	The parent order id will be provided only for applicable orders.
`tradedPrice`	float	The average traded price for the order
`source`	string	Source from where the order was placed. View Details
`fytoken`	string	Fytoken is a unique identifier for every symbol. View Details
`offlineOrder`	boolean	False => When market is open True => When placing AMO order
`pan`	string	PAN of the client
`clientId`	string	The client id of the fyers user
`exchange`	int	The exchange in which order is placed View Details
`instrument`	int	Exchange instrument type View Details
`id_fyers`	string	Fyers system-generated unique identifier for the order.

Request

from fyers_apiv3.FyersWebsocket import order_ws

def onOrder(message):
    """
    Callback function to handle incoming messages from the FyersDataSocket WebSocket.

    Parameters:
        message (dict): The received message from the WebSocket.

    """
    print("Order Response:", message)

def onerror(message):
    """
    Callback function to handle WebSocket errors.

    Parameters:
        message (dict): The error message received from the WebSocket.

    """
    print("Error:", message)


def onclose(message):
    """
    Callback function to handle WebSocket connection close events.
    """
    print("Connection closed:", message)


def onopen():
    """
    Callback function to subscribe to data type and symbols upon WebSocket connection.

    """
    # Specify the data type and symbols you want to subscribe to
    data_type = "OnOrders"
    # data_type = "OnTrades"
    # data_type = "OnPositions"
    # data_type = "OnGeneral"
    # data_type = "OnOrders,OnTrades,OnPositions,OnGeneral"

    fyers.subscribe(data_type=data_type)

    # Keep the socket running to receive real-time data
    fyers.keep_running()


# Replace the sample access token with your actual access token obtained from Fyers
access_token = "AAAAAAAA-100:eyJ..."

# Create a FyersDataSocket instance with the provided parameters
fyers = order_ws.FyersOrderSocket(
    access_token=access_token,  # Your access token for authenticating with the Fyers API.
    write_to_file=False,        # A boolean flag indicating whether to write data to a log file or not.
    log_path="",                # The path to the log file if write_to_file is set to True (empty string means current directory).
    on_connect=onopen,          # Callback function to be executed upon successful WebSocket connection.
    on_close=onclose,           # Callback function to be executed when the WebSocket connection is closed.
    on_error=onerror,           # Callback function to handle any WebSocket errors that may occur.
    on_orders=onOrder,          # Callback function to handle order-related events from the WebSocket.
)


# Establish a connection to the Fyers WebSocket
fyers.connect()

{
  "s":"ok",
  "orders":{
      "clientId":"FY****",
      "id":"23080400089344",
      "exchOrdId":"1100000009596016",
      "qty":1,
      "filledQty":1,
      "limitPrice":7.95,
      "type":1,
      "fyToken":"101000000014366",
      "exchange":10,
      "segment":10,
      "symbol":"NSE:IDEA-EQ",
      "instrument":0,
      "offlineOrder":false,
      "orderDateTime":"04-Aug-2023 10:12:58",
      "orderValidity":"DAY",
      "productType":"INTRADAY",
      "side":-1,
      "status":90,
      "source":"W",
      "ex_sym":"IDEA",
      "description":"VODAFONE IDEA LIMITED",
      "orderNumStatus":"23080400089344:2",
      "id_fyers":"1b30241e-2819-4ec9-a3e4-69b6155cacab"
  }
}