Data Socket - Indices Update

This WebSocket allows you to stream live index values such as NIFTY 50 and NIFTY Bank.

USE CASE

Show live index levels in a market header, or compare a stock's move with its index.

Details

The WebSocket API for receiving stock data is a real-time communication protocol designed to provide seamless and low-latency access to live stock market data. This API allows developers and traders to establish a persistent, bidirectional connection with the server, enabling them to receive continuous updates on stock prices, trading volumes, and other relevant market information.
To quickly get started with the WebSocket API and start receiving real-time stock data, you can explore our sample scripts and code examples in our GitHub repository:
Data WebSocket Sample Scripts
Subscribe with data_type set to SymbolUpdate and index symbols such as NSE:NIFTY50-INDEX or NSE:NIFTYBANK-INDEX.
Index messages have type set to if.
An index message has only symbol, ltp, prev_close_price, high_price, low_price, open_price, ch, chp and type. Volume and bid or ask fields are not sent.
A missing symbol key in index updates was fixed on 22 Aug 2025 (Java v1.3.0). Use a recent SDK version. See the Change Log.

Plan limits

Standard plan

Up to 100 symbols, counted per user across all connections

Prime plan

Up to 5,000 symbols, counted per user across all connections

For rate limits and all other plan details, see Plans & rate limits.

Response Attributes (Index Update)

Attribute	Data Type	Description
`symbol`	string	The symbol in fyers symbology format whose data is received on socket.
`ltp`	float	Last traded price of security or asset.
`prev_close_price`	float	Previous day's close of security or asset.
`high_price`	float	Current day's high of security or asset.
`low_price`	float	Current day's low of security or asset.
`open_price`	float	Current day's open of security or asset.
`ch`	float	Change in price of security or asset today.
`chp`	float	Change in price in % of security or asset today.
`type`	string	cn - connection message sub - subscribe message if - index data message dp - market depth data message sf - Equity and option data message

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)


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:NIFTY50-INDEX" , "NSE:NIFTYBANK-INDEX"]
    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 = "XC4XXXXXXM-100:eXXXXXXXXXXXXfZNSBoLo"

# 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()

{
     "symbol":"NSE:NIFTY50-INDEX",
      "ch":"-27.95",
      "high_price":"26277.35",
      "ltp":"26188.1",
      "exch_feed_time":"1727428424",
      "chp":"-0.11",
      "low_price":"26166.95",
      "open_price":"26248.25",
      "type":"if",
      "prev_close_price":"26216.05"
  }

Data Socket - Indices Update

Response Attributes (Index Update)

Video learning