Data Socket - Connect and Subscribe

This WebSocket allows you to connect to the Data Socket and subscribe to live updates for your symbols.

USE CASE

Subscribe to the stocks on your watchlist and receive every price update in your callback.

Details

The Data Socket provides real-time market data with low latency over a persistent, bidirectional connection, such as symbol updates and depth updates.
Subscription limits and best practices (single instance, thread handling, updating symbols, callbacks, auto-reconnect, reconnect retry and logging) are on the Data Socket Overview.
The higher symbol limit applies from Python v3.1.0, Node v1.1.1 and Web JS v1.1.0, so use these versions or later. See the Change Log.
Pass the access token in the format appid:accesstoken.
Subscribe from the on-connect callback so symbols are requested as soon as the connection opens. In Python, call keep_running() afterwards to keep receiving data.
Use FYERS symbology, for example NSE:SBIN-EQ for a stock or NSE:NIFTY50-INDEX for an index. In Python, data_type is SymbolUpdate for prices and indices, or DepthUpdate for market depth.
Each message has a type: cn connection, sub subscribe, sf equity and option data, if index data, dp market depth.
To receive only the last traded price, set litemode=True when you create the socket in Python, or call mode(LiteMode) in Node and Web JS. See Lite Mode.
With auto-reconnect on, previous symbols are resubscribed automatically after a reconnect.

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.

Request

from fyers_apiv3.FyersWebsocket import data_ws

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.
    reconnect_retry=10               # Number of times reconnection will be attepmted in case
)

Data Socket - Connect and Subscribe

Video learning