Data Socket - Unsubscribe and Connection Management

This WebSocket allows you to unsubscribe from symbols and manage your Data Socket connection.

USE CASE

Stop updates for symbols you no longer track, for example when a watchlist is closed or a position is exited.

Details

To stop receiving real-time data updates for a specific stock symbol or a group of symbols, you can utilize the "unsubscribe" action in the WebSocket API. Sending an "unsubscribe" message will remove the specified symbol(s) from your active subscriptions, and you will no longer receive updates for those symbols.
You can check the sample code to know how to unsubscribe to already subscribed symbols.
After a reconnect, previous symbols are resubscribed through auto-reconnect. To then update your symbol list, it is recommended to unsubscribe from the existing list and resubscribe with the updated list. See Updating subscribed symbols under Web Socket Introduction.
In Python, call unsubscribe with the symbols and the same data_type you used to subscribe, for example SymbolUpdate.
A successful unsubscribe returns type unsub, code 200 and s ok. The message text differs by SDK (Python: Unsubscribed; Node: successful).
You can run the call from the message callback, for example to drop a symbol once your condition is met.
For a changed symbol list, unsubscribe from the current list and subscribe again. Do not open a second connection, because only one connection instance is allowed.
Set reconnect=True so a dropped connection recovers on its own. reconnect_retry sets the retry count, up to 50.
Handle disconnects and errors in the on-close and on-error callbacks.

Request

from fyers_apiv3.FyersWebsocket import data_ws

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

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

    """
    print("Response:", message)
    # After processing or when you decide to unsubscribe for specific symbol and data_type
    # you can use the fyers.unsubscribe() method

    # Example of condition: Unsubscribe when a certain condition is met
    if message['symbol']== 'NSE:SBIN-EQ' and message['ltp'] > 610:
        # Unsubscribe from the specified symbols and data type
        data_type = "SymbolUpdate"
        symbols_to_unsubscribe = ['NSE:SBIN-EQ']
        fyers.unsubscribe(symbols=symbols_to_unsubscribe, data_type=data_type)


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 = "SymbolUpdate"

    # Subscribe to the specified symbols and data type
    symbols = ['NSE:SBIN-EQ', 'NSE:ADANIENT-EQ']
    fyers.subscribe(symbols=symbols, 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 = "XXDHHIOKS-100:eajoljXXXXXXXXXX"

# Create a FyersDataSocket instance with the provided parameters
fyers = data_ws.FyersDataSocket(
    access_token=access_token,       # Access token in the format "appid:accesstoken"
    log_path="",                     # Path to save logs. Leave empty to auto-create logs in the current directory.
    litemode=False,                  # Lite mode disabled. Set to True if you want a lite response.
    write_to_file=False,              # Save response in a log file instead of printing it.
    reconnect=True,                  # Enable auto-reconnection to WebSocket on disconnection.
    on_connect=onopen,               # Callback function to subscribe to data upon connection.
    on_close=onclose,                # Callback function to handle WebSocket connection close events.
    on_error=onerror,                # Callback function to handle WebSocket errors.
    on_message=onmessage             # Callback function to handle incoming messages from the WebSocket.
)

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

{'type': 'unsub', 'code': 200, 'message': 'Unsubscribed', 's': 'ok'}

Data Socket - Unsubscribe and Connection Management

Video learning