fyers-apiv3 3.1.5__py3-none-any.whl → 3.1.7__py3-none-any.whl

fyers_apiv3/FyersWebsocket/msg_pb2.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: msg.proto
+# Protobuf Python Version: 5.26.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import wrappers_pb2 as google_dot_protobuf_dot_wrappers__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\tmsg.proto\x1a\x1egoogle/protobuf/wrappers.proto\"\xbb\x01\n\x0bMarketLevel\x12*\n\x05price\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12)\n\x03qty\x18\x02 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12*\n\x04nord\x18\x03 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12)\n\x03num\x18\x04 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\"\x95\x01\n\x05\x44\x65pth\x12)\n\x03tbq\x18\x01 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12)\n\x03tsq\x18\x02 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12\x1a\n\x04\x61sks\x18\x03 \x03(\x0b\x32\x0c.MarketLevel\x12\x1a\n\x04\x62ids\x18\x04 \x03(\x0b\x32\x0c.MarketLevel\"\xb7\x02\n\x05Quote\x12(\n\x03ltp\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12)\n\x03ltt\x18\x02 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12)\n\x03ltq\x18\x03 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12)\n\x03vtt\x18\x04 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12.\n\x08vtt_diff\x18\x05 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12(\n\x02oi\x18\x06 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12)\n\x04ltpc\x18\x07 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\"\x88\x03\n\rExtendedQuote\x12(\n\x03\x61tp\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12\'\n\x02\x63p\x18\x02 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12(\n\x02lc\x18\x03 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12(\n\x02uc\x18\x04 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12\'\n\x02yh\x18\x05 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12\'\n\x02yl\x18\x06 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12)\n\x03poi\x18\x07 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12)\n\x04oich\x18\x08 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12(\n\x02pc\x18\t \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\"\x88\x02\n\nDailyQuote\x12\'\n\x02\x64o\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12\'\n\x02\x64h\x18\x02 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12\'\n\x02\x64l\x18\x03 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12\'\n\x02\x64\x63\x18\x04 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12*\n\x04\x64hoi\x18\x05 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12*\n\x04\x64loi\x18\x06 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\"\x8e\x02\n\x05OHLCV\x12)\n\x04open\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12)\n\x04high\x18\x02 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12(\n\x03low\x18\x03 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12*\n\x05\x63lose\x18\x04 \x01(\x0b\x32\x1b.google.protobuf.Int64Value\x12,\n\x06volume\x18\x05 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\x12+\n\x05\x65poch\x18\x06 \x01(\x0b\x32\x1c.google.protobuf.UInt32Value\"\x1d\n\tSymDetail\x12\x10\n\x08ticksize\x18\x01 \x01(\t\"\xcd\x02\n\nMarketFeed\x12\x15\n\x05quote\x18\x01 \x01(\x0b\x32\x06.Quote\x12\x1a\n\x02\x65q\x18\x02 \x01(\x0b\x32\x0e.ExtendedQuote\x12\x17\n\x02\x64q\x18\x03 \x01(\x0b\x32\x0b.DailyQuote\x12\x15\n\x05ohlcv\x18\x04 \x01(\x0b\x32\x06.OHLCV\x12\x15\n\x05\x64\x65pth\x18\x05 \x01(\x0b\x32\x06.Depth\x12/\n\tfeed_time\x18\x06 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12/\n\tsend_time\x18\x07 \x01(\x0b\x32\x1c.google.protobuf.UInt64Value\x12\r\n\x05token\x18\x08 \x01(\t\x12\x13\n\x0bsequence_no\x18\t \x01(\x04\x12\x10\n\x08snapshot\x18\n \x01(\x08\x12\x0e\n\x06ticker\x18\x0b \x01(\t\x12\x1d\n\tsymdetail\x18\x0c \x01(\x0b\x32\n.SymDetail\"\xbe\x01\n\rSocketMessage\x12\x1a\n\x04type\x18\x01 \x01(\x0e\x32\x0c.MessageType\x12(\n\x05\x66\x65\x65\x64s\x18\x02 \x03(\x0b\x32\x19.SocketMessage.FeedsEntry\x12\x10\n\x08snapshot\x18\x03 \x01(\x08\x12\x0b\n\x03msg\x18\x04 \x01(\t\x12\r\n\x05\x65rror\x18\x05 \x01(\x08\x1a\x39\n\nFeedsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1a\n\x05value\x18\x02 \x01(\x0b\x32\x0b.MarketFeed:\x02\x38\x01*\x86\x01\n\x0bMessageType\x12\x08\n\x04ping\x10\x00\x12\t\n\x05quote\x10\x01\x12\x12\n\x0e\x65xtended_quote\x10\x02\x12\x0f\n\x0b\x64\x61ily_quote\x10\x03\x12\x10\n\x0cmarket_level\x10\x04\x12\t\n\x05ohlcv\x10\x05\x12\t\n\x05\x64\x65pth\x10\x06\x12\x07\n\x03\x61ll\x10\x07\x12\x0c\n\x08response\x10\x08\x42\nZ\x08/gencodeb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'msg_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'Z\010/gencode'
+  _globals['_SOCKETMESSAGE_FEEDSENTRY']._loaded_options = None
+  _globals['_SOCKETMESSAGE_FEEDSENTRY']._serialized_options = b'8\001'
+  _globals['_MESSAGETYPE']._serialized_start=2197
+  _globals['_MESSAGETYPE']._serialized_end=2331
+  _globals['_MARKETLEVEL']._serialized_start=46
+  _globals['_MARKETLEVEL']._serialized_end=233
+  _globals['_DEPTH']._serialized_start=236
+  _globals['_DEPTH']._serialized_end=385
+  _globals['_QUOTE']._serialized_start=388
+  _globals['_QUOTE']._serialized_end=699
+  _globals['_EXTENDEDQUOTE']._serialized_start=702
+  _globals['_EXTENDEDQUOTE']._serialized_end=1094
+  _globals['_DAILYQUOTE']._serialized_start=1097
+  _globals['_DAILYQUOTE']._serialized_end=1361
+  _globals['_OHLCV']._serialized_start=1364
+  _globals['_OHLCV']._serialized_end=1634
+  _globals['_SYMDETAIL']._serialized_start=1636
+  _globals['_SYMDETAIL']._serialized_end=1665
+  _globals['_MARKETFEED']._serialized_start=1668
+  _globals['_MARKETFEED']._serialized_end=2001
+  _globals['_SOCKETMESSAGE']._serialized_start=2004
+  _globals['_SOCKETMESSAGE']._serialized_end=2194
+  _globals['_SOCKETMESSAGE_FEEDSENTRY']._serialized_start=2137
+  _globals['_SOCKETMESSAGE_FEEDSENTRY']._serialized_end=2194
+# @@protoc_insertion_point(module_scope)

fyers_apiv3/FyersWebsocket/tbt_ws.py

@@ -0,0 +1,594 @@
+from typing import Any, Callable, Dict, Optional
+from pkg_resources import resource_filename
+import websocket
+from threading import Thread
+import logging
+import threading
+import time
+import json
+from fyers_apiv3.FyersWebsocket import defines
+from fyers_apiv3.fyers_logger import FyersLogger
+from typing import Set, List
+import fyers_apiv3.FyersWebsocket.msg_pb2 as protomsg
+from enum import Enum
+import requests
+
+## Models and definitions
+
+def getUrl(access_token: str):
+    """
+    Get the URL for the WebSocket connection.
+
+    Args:
+        access_token (str): The access token to authenticate with. Format: APPID:SECRET_KEY
+
+    Returns:
+        str: The URL for the WebSocket connection.
+    """
+    data = requests.get('https://api-t1.fyers.in/indus/home/tbtws', headers={'Authorization': f'{access_token}'})
+    if data.status_code == 200:
+        return data.json()['data']['socket_url']
+    return "wss://rtsocket-api.fyers.in/versova"
+
+class SubscriptionModes(Enum):
+    DEPTH = "depth"
+
+class Depth:
+    def __init__(self):
+        self.tbq: int = 0
+        self.tsq: int = 0
+        self.bidprice: List[float] = [0.0] * 50
+        self.askprice: List[float] = [0.0] * 50
+        self.bidqty: List[float] = [0] * 50
+        self.askqty: List[float] = [0] * 50
+        self.bidordn: List[float] = [0] * 50
+        self.askordn: List[float] = [0] * 50
+        self.snapshot: bool = False
+        self.timestamp: int = 0
+        self.sendtime: int = 0
+        self.seqNo: int = 0
+
+    def __str__(self):
+        return (f"Depth{{ts: {self.timestamp}, "
+                f"send_ts: {self.sendtime}, "
+                f"tbq: {self.tbq}, tsq: {self.tsq}, "
+                f"bidprice: {self.bidprice}, askprice: {self.askprice}, "
+                f"bidqty: {self.bidqty}, askqty: {self.askqty}, "
+                f"bidordn: {self.bidordn}, askordn: {self.askordn}, "
+                f"snapshot: {self.snapshot}, sNo: {self.seqNo} }}")
+    
+    def _addDepth(self, currdata: protomsg.MarketFeed, isSnapshot: bool):
+        if currdata.HasField('depth'):
+            self.snapshot = isSnapshot
+            if currdata.depth.HasField('tbq'):
+                self.tbq = currdata.depth.tbq.value
+
+            if currdata.depth.HasField('tsq'):
+                self.tsq = currdata.depth.tsq.value
+
+            if currdata.depth.asks is not None:
+                for i in range(len(currdata.depth.asks)):
+                    if currdata.depth.asks[i].HasField('price'):
+                        self.askprice[i] = currdata.depth.asks[i].price.value / 100
+
+                    if currdata.depth.asks[i].HasField('qty'):
+                        self.askqty[i] = currdata.depth.asks[i].qty.value
+
+                    if currdata.depth.asks[i].HasField('nord'):
+                        self.askordn[i] = currdata.depth.asks[i].nord.value
+                        
+            if currdata.depth.bids is not None:
+                for i in range(len(currdata.depth.bids)):
+                    if currdata.depth.bids[i].HasField('price'):
+                        self.bidprice[i] = currdata.depth.bids[i].price.value / 100
+
+                    if currdata.depth.bids[i].HasField('qty'):
+                        self.bidqty[i] = currdata.depth.bids[i].qty.value
+
+                    if currdata.depth.bids[i].HasField('nord'):
+                        self.bidordn[i] = currdata.depth.bids[i].nord.value
+            
+            self.timestamp = currdata.feed_time.value
+            self.sendtime = currdata.send_time.value
+            self.seqNo = currdata.sequence_no
+
+class SubscriptionInfo:
+    def __init__(self) -> None:
+        self._symbols: Dict[str, Set[str]] = {}
+        self._modeInfo: Dict[str, SubscriptionModes] = {}
+        self._activeChannels: Set[str] = set()
+
+    def subscribe(self, symbols: Set[str], channelNo: str, mode: SubscriptionModes) -> None:
+        if channelNo in self._symbols:
+            self._symbols[channelNo].update(symbols)
+        else:
+            self._symbols[channelNo] = set(symbols)
+        self._modeInfo[channelNo] = mode
+
+    def unsubscribe(self, symbols: Set[str], channelNo: str) -> None:
+        if channelNo in self._symbols:
+            self._symbols[channelNo].difference_update(symbols)
+            if not self._symbols[channelNo]:
+                del self._symbols[channelNo]
+
+    def updateChannels(self, pauseChannels: Set[str], resumeChannels: Set[str]) -> None:
+        self._activeChannels.difference_update(pauseChannels)
+        self._activeChannels.update(resumeChannels)
+
+    def updateMode(self, modeConfig: Dict[str, SubscriptionModes]) -> None:
+        for channelNo, mode in modeConfig.items():
+            self._modeInfo[channelNo] = mode
+
+    def getSymbolsInfo(self, chanNo: str) -> Set[str]:
+        return self._symbols[chanNo]
+
+    def getModeInfo(self, chanNo: str) -> SubscriptionModes:
+        return self._modeInfo[chanNo]
+
+    def getChannelInfo(self) -> Set[str]:
+        return self._activeChannels
+    
+
+class DataStore:
+  depth: Dict[str, Depth] = {}
+
+  def updateDepth(self, packet: protomsg.SocketMessage, cb: Optional[Callable], diffOnly: bool):
+    if packet.feeds is not None:
+        for _, value in packet.feeds.items():
+            symbol = value.ticker
+            if symbol not in self.depth:
+                self.depth[symbol] = Depth()
+            if not diffOnly:
+                self.depth[symbol]._addDepth(value, packet.snapshot)
+                cb(symbol, self.depth[symbol])     
+            else:
+                depth = Depth() 
+                depth._addDepth(value, packet.snapshot)
+                cb(symbol, depth)     
+
+
+class FyersTbtSocket:
+
+    _instance = None
+
+    def __new__(cls, *args, **kwargs):
+        if not cls._instance:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(
+        self,
+        access_token: str,
+        write_to_file: Optional[bool] = False,
+        log_path: Optional[str] = None,
+        on_depth_update: Optional[Callable] = None,
+        on_error_message:   Optional[Callable] = None,
+        on_error: Optional[Callable] = None,
+        on_connect: Optional[Callable] = None,
+        on_close: Optional[Callable] = None,
+        on_open: Optional[Callable] = None,
+        reconnect : Optional[Callable] = True,
+        diff_only: bool = False,
+        reconnect_retry: int = 5 
+    ) -> None:
+        """
+        Initializes the class instance.
+
+        Args:
+            access_token (str): The access token to authenticate with.
+            write_to_file (bool, optional): Flag indicating whether to save data to a file. Defaults to False.
+            log_path (str, optional): The path to the log file. Defaults to None.
+            on_depth_update (callable, optional): Callback function for 50 depth events. Defaults to None.
+            on_error_message (callable, optional): Callback function for error msg received from server. Defaults to None.
+            on_error (callable, optional): Callback function for error events. Defaults to None.
+            on_connect (callable, optional): Callback function for connect events. Defaults to None.
+            on_close (callable, optional): Callback function for close events. Defaults to None.
+            on_open (callable, optional): Callback function for open events. Defaults to None.
+            reconnect (bool, optional): Flag indicating whether to attempt reconnection on disconnection. Defaults to True.
+        """
+        self._datastore = DataStore()
+        self._subsinfo = SubscriptionInfo()
+        self.__access_token = access_token
+        self.log_path = log_path
+        self.__ws_object = None
+        self.__ws_run = False
+        self.ping_thread = None
+        self.write_to_file = write_to_file
+        self.background_flag = False
+        self.reconnect_delay = 0
+        self.onDepthUpdate = on_depth_update
+        self.onErrorMsg = on_error_message
+        self.restart_flag = reconnect
+        self.onerror = on_error
+        self.onopen = on_connect
+        self.max_reconnect_attempts = 50
+        self.reconnect_attempts = 0
+        self.diff_only = diff_only
+        if reconnect_retry < self.max_reconnect_attempts:
+            self.max_reconnect_attempts = reconnect_retry
+
+        self.onclose = on_close
+        self.onopen = on_open
+        self.__ws_object = None
+        self.running_thread=None
+        self.__url = getUrl(access_token)
+
+        if log_path:
+            self.tbtlogger = FyersLogger(
+                "FyersTbtSocket",
+                "DEBUG",
+                stack_level=2,
+                logger_handler=logging.FileHandler(log_path + "/fyersTBTSocket.log"),
+            )
+        else:
+            self.tbtlogger = FyersLogger(
+                "FyersTbtSocket",
+                "DEBUG",
+                stack_level=2,
+                logger_handler=logging.FileHandler("fyersTBTSocket.log"),
+            )
+        self.websocket_task = None
+
+        self.write_to_file = write_to_file
+        self.background_flag = False
+        
+    def subscribe(self, symbol_tickers: Set[str], channelNo: str, mode: SubscriptionModes) -> None:
+        """
+        Subscribe to a specific channel with the given symbols and mode.
+
+        Args:
+            symbol_tickers (Set[str]): The set of symbol tickers to subscribe to.
+            channelNo (str): The channel number to subscribe to. Should be between 1 and 50
+            mode (SubscriptionModes): The mode of subscription.
+        """
+        if (
+            self.__ws_object is not None
+            and self.__ws_object.sock
+            and self.__ws_object.sock.connected
+        ):
+            self._subsinfo.subscribe(symbol_tickers, channelNo, mode)
+            self.__ws_object.send(
+                json.dumps(
+                    {
+                        "type": 1,
+                        "data": {
+                            "subs": 1,
+                            "symbols": list(symbol_tickers),
+                            "mode": mode.value,
+                            "channel": channelNo,
+                        },
+                    }
+                )
+            )
+
+    def unsubscribe(self, symbol_tickers: Set[str], channelNo: str, mode: SubscriptionModes) -> None:
+        """
+        Unsubscribe from a specific channel with the given symbols and mode.
+
+        Args:
+            symbol_tickers (Set[str]): The set of symbol tickers to unsubscribe from.
+            channelNo (str): The channel number to unsubscribe from. Should be between 1 and 50
+            mode (SubscriptionModes): The mode of subscription.
+        """
+        if (
+            self.__ws_object is not None
+            and self.__ws_object.sock
+            and self.__ws_object.sock.connected
+        ):  
+            self._subsinfo.unsubscribe(symbol_tickers, channelNo)
+            self.__ws_object.send(
+                json.dumps(
+                    {
+                        "type": 1,
+                        "data": {
+                            "subs": -1,
+                            "symbols": list(symbol_tickers),
+                            "mode": mode.value,
+                            "channel": channelNo,
+                        },
+                    }
+                )
+            )
+    
+    def switchChannel(self, resume_channels: Set[str], pause_channels: Set[str]) -> None:
+        """
+        Resume and pause channels to receive data from the server.
+
+        Args:
+            resume_channels (Set[str]): The set of channels to resume. Data will be received for symbols on these channels.
+            pause_channels (Set[str]): The set of channels to pause. Data will be paused for symbols on these channels.
+        """
+        if (
+            self.__ws_object is not None
+            and self.__ws_object.sock
+            and self.__ws_object.sock.connected
+        ):
+            self._subsinfo.updateChannels(pause_channels, resume_channels)
+            self.__ws_object.send(
+                json.dumps(
+                    {
+                        "type": 2,
+                        "data": {
+                            "resumeChannels": list(resume_channels),
+                            "pauseChannels": list(pause_channels)
+                        }
+                    }
+                )
+            )
+
+    def on_depth_update(self, ticker: str, message: Depth):
+        """
+        Callback function for depth update events.
+
+        Args:
+            ticker (str): The ticker symbol.
+            message (Depth): The depth message.
+        """
+        try:
+            if self.onDepthUpdate is not None:
+                self.onDepthUpdate(ticker, message)
+            else:
+                if self.write_to_file:
+                    self.tbtlogger.debug(f"{ticker}: {message}")
+                else:
+                    print(f"{ticker}: {message}")
+                
+        except Exception as e:
+            self.tbtlogger.error(e)
+            self.On_error(e)
+
+    def on_error_message(self, message: str):
+        """
+        Callback function for error message events from the server
+
+        Args:
+            message (str): The error message.
+        """
+        try:
+            if self.onErrorMsg is not None:
+                self.onErrorMsg(message)
+            else:
+                print(f"error received from server: {message}")
+        except Exception as e:
+            self.tbtlogger.error(e)
+            self.On_error(e)
+    
+    def __on_message(self, message: Dict[str, Any]):
+        """
+        Parses the response data based on its content.
+
+        Args:
+            message (str): The response message to be parsed.
+
+        Returns:
+            Any: The parsed response data.
+        """
+        try:
+            if message != "pong":
+                d = protomsg.SocketMessage()
+                d.ParseFromString(message)
+                if d.error:
+                    self.on_error_message(d.msg)
+                else:
+                    self._datastore.updateDepth(d, self.on_depth_update, self.diff_only)
+            
+
+        except Exception as e:
+            self.tbtlogger.error(e)
+            self.On_error(e)
+
+    def On_error(self, message: str) -> None:
+        """
+        Callback function for handling error events.
+
+        Args:
+            message (str): The error message.
+
+        """
+        if self.onerror is not None:
+            self.onerror(message)
+            self.tbtlogger.error(message)
+        else:
+            if self.write_to_file:
+                self.tbtlogger.debug(f"Response:{message}")
+            else:
+                print(f"Error Response : {message}")
+
+    def __on_open(self, ws):
+        """
+        Callback function for open events from the server
+
+        Args:
+            ws (WebSocket): The WebSocket object.
+        """
+        try:
+            if self.__ws_object is None:
+                self.__ws_object = ws
+                self.ping_thread = threading.Thread(target=self.__ping)
+                self.ping_thread.start()
+                self.reconnect_attempts = 0
+                self.reconnect_delay = 0
+                self.on_open()
+
+        except Exception as e:
+            self.tbtlogger.error(e)
+            self.On_error(e)
+
+    def __on_close(self, ws, close_code=None, close_reason=None):
+        """
+        Handle the WebSocket connection close event.
+
+        Args:
+            ws (WebSocket): The WebSocket object.
+            close_code (int): The code indicating the reason for closure.
+            close_reason (str): The reason for closure.
+
+        Returns:
+            dict: A dictionary containing the response code, message, and s.
+        """
+        try:
+            if self.restart_flag:
+                if self.reconnect_attempts < self.max_reconnect_attempts:
+                    if self.write_to_file:
+                        self.tbtlogger.debug(
+                            f"Response:{f'Attempting reconnect {self.reconnect_attempts} of {self.max_reconnect_attempts}...'}"
+                        )
+                    else:
+                        print(
+                            f"Attempting reconnect {self.reconnect_attempts+1} of {self.max_reconnect_attempts}..."
+                        )
+                    if (self.reconnect_attempts) % 5 == 0:
+                        self.reconnect_delay += 5
+                    time.sleep(self.reconnect_delay)
+                    self.reconnect_attempts += 1
+
+                    self.__ws_object = None
+                    self.connect()
+                else:
+                    if self.write_to_file:
+                        self.tbtlogger.debug(
+                            f"Response:{'Max reconnect attempts reached. Connection abandoned.'}"
+                        )
+                    else:
+                        print("Max reconnect attempts reached. Connection abandoned.")
+            else:
+
+                self.on_close(
+                    {
+                        "code": defines.SUCCESS_CODE,
+                        "message": defines.CONNECTION_CLOSED,
+                        "s": defines.SUCCESS,
+                    }
+                )
+        except Exception as e:
+            self.tbtlogger.error(e)
+            self.On_error(e)
+
+    def __ping(self) -> None:
+        """
+        Sends periodic ping messages to the server to maintain the WebSocket connection.
+
+        The method continuously sends "__ping" messages to the server at a regular interval
+        as long as the WebSocket connection is active.
+
+        """
+
+        while (
+            self.__ws_object is not None
+            and self.__ws_object.sock
+            and self.__ws_object.sock.connected
+        ):
+            self.__ws_object.send("ping")
+            time.sleep(10)
+
+    def on_close(self, message: dict) -> None:
+        """
+        Handles the close event.
+
+        Args:
+            message (dict): The close message .
+        """
+
+        if self.onclose:
+            self.onclose(message)
+        else:
+            print(f"Response: {message}")
+
+    def on_open(self) -> None:
+        """
+        Performs initialization and waits before executing further actions.
+        """
+        try:
+            if self.onopen:
+                self.onopen()
+                open_chans = self._subsinfo.getChannelInfo()
+                self.switchChannel(self._subsinfo.getChannelInfo(), set())
+                for channel in open_chans:
+                    self.subscribe(self._subsinfo.getSymbolsInfo(channel), channel, self._subsinfo.getModeInfo(channel))
+        except Exception as e:
+            self.On_error(e)
+
+    def is_connected(self):
+        """
+        Check if the websocket is connected.
+
+        Returns:
+            bool: True if the websocket is connected, False otherwise.
+        """
+        if self.__ws_object:
+            return True
+        else:
+            return False
+        
+
+    def __init_connection(self):
+        """
+        Initializes the WebSocket connection and starts the WebSocketApp.
+
+        The method creates a WebSocketApp object with the specified URL and sets the appropriate event handlers.
+        It then starts the WebSocketApp in a separate thread.
+        """
+        try:
+            if self.__ws_object is None:
+                if self.write_to_file:
+                    self.background_flag = False
+                header = {"authorization": self.__access_token}
+                ws = websocket.WebSocketApp(
+                    self.__url,
+                    header=header,
+                    on_message=lambda ws, msg: self.__on_message(msg),
+                    on_error=lambda ws, msg: self.On_error(msg),
+                    on_close=lambda ws, close_code, close_reason: self.__on_close(
+                        ws, close_code, close_reason
+                    ),
+                    on_open=lambda ws: self.__on_open(ws),
+                )
+                self.t = Thread(target=ws.run_forever) 
+                self.t.daemon = self.background_flag
+                self.t.start()
+
+        except Exception as e:
+            self.tbtlogger.error(e)
+
+    def keep_running(self):
+        """
+        Starts an infinite loop to keep the program running.
+
+        """
+        self.__ws_run = True
+        self.running_thread = Thread(target=self.infinite_loop)
+        self.running_thread.start()
+
+    def stop_running(self):
+        self.__ws_run = False
+
+    def infinite_loop(self):
+        while self.__ws_run:
+            time.sleep(0.5)
+
+    def connect(self) -> None:
+        """
+        Establishes a connection to the WebSocket.
+
+        If the WebSocket object is not already initialized, this method will create the
+        WebSocket connection.
+
+        """
+        if self.__ws_object is None:
+            self.__init_connection()
+            time.sleep(2)
+
+            
+    def close_connection(self):
+        """
+        Closes the WebSocket connection 
+
+        """
+        if self.__ws_object is not None:
+            self.restart_flag = False
+            self.__ws_object.close()
+            self.__ws_object = None
+            self.__ws_run = None
+            self.running_thread.join()
+            self.t.join()
+            self.ping_thread.join()

fyers_apiv3/fyersModel.py

@@ -40,6 +40,7 @@ class Config:
     market_depth = "/depth"
     option_chain = "/options-chain-v3"
     multileg_orders = "/multileg/orders/sync"
+    logout = "/logout"
 
 
 
@@ -657,6 +658,18 @@ class FyersModel:
             response = self.service.get_call(Config.holdings, self.header)
         return response
 
+    def logout(self) -> dict:
+        """
+        Invalidates the access token.
+
+        """
+        if self.is_async:
+            response = self.service.post_async_call(Config.logout, self.header)
+            
+        else:
+            response = self.service.post_call(Config.logout, self.header)
+        return response
+
     def get_orders(self, data) -> dict:
         """
         Retrieves order details by ID.

{fyers_apiv3-3.1.5.dist-info → fyers_apiv3-3.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: fyers_apiv3
-Version: 3.1.5
+Version: 3.1.7
 Summary: Fyers trading APIs.
 Home-page: https://github.com/FyersDev/fyers-api-sample-code/tree/sample_v3/v3/python
 Author: Fyers-Tech
@@ -15,6 +15,7 @@ Requires-Dist: asyncio==3.4.3
 Requires-Dist: aiohttp==3.9.3
 Requires-Dist: aws_lambda_powertools==1.25.5
 Requires-Dist: websocket-client==1.6.1
+Requires-Dist: protobuf==5.29.3
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -530,4 +531,91 @@ fyers = order_ws.FyersOrderSocket(
 fyers.connect()
 
 
+```
+
+## Getting started with TBT Socket
+
+```python
+from  fyers_apiv3.FyersWebsocket.tbt_ws import FyersTbtSocket, SubscriptionModes
+
+def on_depth_update(ticker, message):
+    """
+    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+
+    Parameters:
+        ticker (str): The symbol for which the message is received.
+        message (dict): The received message from the WebSocket.
+
+    """
+    print("Depth Response:", ticker, message)
+
+
+def onerror_message( message):
+    """
+    Callback function to handle incoming messages from the FyersDataSocket WebSocket.
+
+    Parameters:
+        message (str): error message from the server
+
+    """
+    print("server returned error:", 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.
+
+    """
+    print("Connection opened")
+    # Specify the data type and symbols you want to subscribe to
+    mode = SubscriptionModes.DEPTH
+    Channel = '1'
+    # Subscribe to the specified symbols and data type
+    symbols = ['NSE:NIFTY25MARFUT']
+    
+    fyers.subscribe(symbol_tickers=symbols, channelNo=Channel, mode=mode)
+    fyers.switchChannel(resume_channels=[Channel], pause_channels=[])
+
+    # 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 = "XCXXXXXXM-100:eyJ0tHfZNSBoLo"
+
+fyers = FyersTbtSocket(
+    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_open=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_depth_update=on_depth_update, # Callback function to handle depth-related events from the WebSocket
+    on_error_message=onerror_message         # Callback function to handle server-related erros from the WebSocket.
+)
+
+
+# Establish a connection to the Fyers WebSocket
+fyers.connect()
+
+
 ```

{fyers_apiv3-3.1.5.dist-info → fyers_apiv3-3.1.7.dist-info}/RECORD

@@ -1,13 +1,15 @@
 fyers_apiv3/__init__.py,sha256=1vA_F8dAtLKcyOqrmdUOkw1Syl8gIFUtxDoLde8y94E,18
-fyers_apiv3/fyersModel.py,sha256=vxasCXeoKog823OsZoYF284u45dlShIxFNs_A8fR8nU,44748
+fyers_apiv3/fyersModel.py,sha256=MHo1NWgphuZBUx-t1VAnqsuLZZS_-9P5xwWOBMIwj_U,45096
 fyers_apiv3/fyers_logger.py,sha256=S_WiIwBLytQ_tyHd9bUC8gZo7GHpANCJO0CS6rCJE90,3795
 fyers_apiv3/FyersWebsocket/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fyers_apiv3/FyersWebsocket/data_ws.py,sha256=fSNfsUB_I5-MkWX4hQZvklRQhuQ9n3w5hMDRFrMaBE8,68105
 fyers_apiv3/FyersWebsocket/defines.py,sha256=mhKkkQ6FZHFa6e0_83cRYMOucmSn5yHtcod1Jn2ygCc,1143
 fyers_apiv3/FyersWebsocket/map.json,sha256=GfAgk-zqzUki5Cu0ZlG08PiMhfKTyGIsPo62mIYotZ4,10075
+fyers_apiv3/FyersWebsocket/msg_pb2.py,sha256=Po6emBFB6aCmt3rkuN6zjDA7JEzsixejfNSOQYtYgnE,6272
 fyers_apiv3/FyersWebsocket/order_ws.py,sha256=npLBtCcpPxclc5YRaVtLvBkRDCF3oV9NabK_y5EwoAk,16998
-fyers_apiv3-3.1.5.dist-info/LICENSE.txt,sha256=_a5I4lWvSmoZQxwGSPGVVvUbuYby780N9YevsBqNY3k,1063
-fyers_apiv3-3.1.5.dist-info/METADATA,sha256=im6F7GlDN0MQi-s6HDxqLgWUDRzOFA0ORK_F3BJQOpw,16446
-fyers_apiv3-3.1.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-fyers_apiv3-3.1.5.dist-info/top_level.txt,sha256=IaT774gXqIM6uJpgCQPvXruJBOINsupO9oTe2ao6pkc,12
-fyers_apiv3-3.1.5.dist-info/RECORD,,
+fyers_apiv3/FyersWebsocket/tbt_ws.py,sha256=rlg0taA9KCS8YbyKZ8UxqRw5rUcqRETz0sbM9KBUcF0,21191
+fyers_apiv3-3.1.7.dist-info/LICENSE.txt,sha256=_a5I4lWvSmoZQxwGSPGVVvUbuYby780N9YevsBqNY3k,1063
+fyers_apiv3-3.1.7.dist-info/METADATA,sha256=JOgjxfBjmTzfhPPt_A0rxaA_ThhD1Tf9_7TZBtKfTro,19232
+fyers_apiv3-3.1.7.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+fyers_apiv3-3.1.7.dist-info/top_level.txt,sha256=IaT774gXqIM6uJpgCQPvXruJBOINsupO9oTe2ao6pkc,12
+fyers_apiv3-3.1.7.dist-info/RECORD,,

{fyers_apiv3-3.1.5.dist-info → fyers_apiv3-3.1.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any