General Socket - General Events

This WebSocket allows you to receive price alert, EDIS and login notifications for your account.

USE CASE

Receive a notification when a price alert triggers or an EDIS update arrives.

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 edis, pricealerts and login actions on the raw socket, or OnGeneral in the Python SDK (callback on_general).
To receive everything in one call in the SDK, use OnOrders,OnTrades,OnPositions,OnGeneral. On the raw socket, list several actions in SLIST.
Each message has a top-level key that tells you its type: orders, trades, positions or, for price alerts, pricealerts.
A price alert message carries title, body and notification_data with fields such as action, alertId, symbol, condition, value and triggeredValue. Creating an alert sends "Alert created".

Request

from fyers_apiv3.FyersWebsocket import order_ws


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

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

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

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 onPosition(message):
    """
    Callback function to handle incoming messages from the FyersDataSocket WebSocket.

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

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

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

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

    """
    print("General 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:YYYYYYYYYYYY"

# 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_general=onGeneral,       # Callback function to handle general events from the WebSocket.
    on_orders=onOrder,          # Callback function to handle order-related events from the WebSocket.
    on_positions=onPosition,    # Callback function to handle position-related events from the WebSocket.
    on_trades=onTrade           # Callback function to handle trade-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"  
    }
  }