o ABi~@sdZddlZddlZddlZddlZddlZddlZddlZddlmZddl m Z m Z ddl m ZddlmZddlmZmZmZdd lmZmZeeZ Gd d d eZGd d d eeZGdddeZdS)z ticker.py Websocket implementation for kite ticker :copyright: (c) 2021 by Zerodha Technology Pvt. Ltd. :license: see LICENSE for details. N)datetime)reactorssl)log)ReconnectingClientFactory)WebSocketClientProtocolWebSocketClientFactory connectWS) __version__ __title__csreZdZdZdZdZdZdZdZdZ fddZ ddZ d d Z d d Z d dZddZ ddZddZZS)KiteTickerClientProtocolz(Kite ticker autobahn WebSocket protocol.g@Ncstt|j|i|dS)z9Initialize protocol with all options passed from factory.N)superr __init__selfargskwargs __class__R/var/www/html/Trade-python/venv/lib/python3.10/site-packages/kiteconnect/ticker.pyr(sz!KiteTickerClientProtocol.__init__cCs,||j_|jjr|j|||jdS)z7Called when WebSocket server connection was establishedN)factoryws on_connect resetDelayrresponserrr onConnect-sz"KiteTickerClientProtocol.onConnectcCs,|||jjr|j|dSdS)zBCalled when the initial WebSocket opening handshake was completed.N) _loop_ping_loop_pong_checkron_openrrrronOpen8s zKiteTickerClientProtocol.onOpencCs |jjr|j|||dSdS)z/Called when text or binary message is received.N)r on_message)rpayload is_binaryrrr onMessageCsz"KiteTickerClientProtocol.onMessagecCsh|s|jjr|j||||jjr|j|||d|_d|_|jr(|j|jr2|jdSdS)z!Called when connection is closed.N)ron_erroron_close_last_ping_time_last_pong_time _next_pingcancel_next_pong_check)r was_cleancodereasonrrronCloseIs z KiteTickerClientProtocol.onClosecCsR|jr|jjrtdt|jt|_|jjr'td|dSdS)z%Called when pong message is received.zlast pong was {} seconds back.z pong => {}N)r,rdebugrformattimerrrronPong\s  zKiteTickerClientProtocol.onPongcCsL|jjr|jrtdt|jt|_|jj|j|j |_ dS)z>Start a ping loop where it sends ping message every X seconds.zlast ping was {} seconds back.N) rr4r+rr5r6r callLater PING_INTERVALr r-r#rrrr js  z#KiteTickerClientProtocol._loop_pingcCs`|jr#t|j}|d|jkr#|jjrtd||jdd|jj |j|j |_ dS)z Timer sortof to check if connection is still there. Checks last pong message time and disconnects the existing connection to make sure it doesn't become a ghost connection. zBLast pong was {} seconds ago. So dropping connection to reconnect.T)abortN) r,r6r9rr4rr5dropConnectionrr8r!r/)rlast_pong_diffrrrr!vs z)KiteTickerClientProtocol._loop_pong_check)__name__ __module__ __qualname____doc__r9KEEPALIVE_INTERVALr-r/r,r+rrr$r(r3r7r r! __classcell__rrrrr s"     r csPeZdZdZeZdZdZdZfddZ ddZ d d Z d d Z d dZ ZS)KiteTickerClientFactoryzQAutobahn WebSocket client factory to implement reconnection and custom callbacks.r NcsPd|_d|_d|_d|_d|_d|_d|_d|_d|_t t |j |i|dS)z/Initialize with default callback method values.FN) r4rr"r)r*r%r on_reconnecton_noreconnectrrDrrrrrrsz KiteTickerClientFactory.__init__cCs$|js |jr tdt|_dS)z$On connecting start or reconnection.zStart WebSocket connection.N)_last_connection_timer4rr6)r connectorrrrstartedConnectings  z)KiteTickerClientFactory.startedConnectingcCsP|jdkrtd|jtt|j|jr||j||| dS)z2On connection failure (When connect request fails)rzNRetrying connection. Retry attempt count: {}. Next retry in around: {} secondsN) retriesrerrorr5introunddelayrFretrysend_noreconnectrrIr2rrrclientConnectionFaileds    z.KiteTickerClientFactory.clientConnectionFailedcCs2|jdkr|jr||j|||dS)z>On connection lost (When ongoing connection got disconnected).rN)rKrFrPrQrRrrrclientConnectionLosts    z,KiteTickerClientFactory.clientConnectionLostcCsT|jdur$|j|jkr&|jrtd|j||jr(|dSdSdSdS)z5Callback `no_reconnect` if max retries are exhausted.NzMaximum retries ({}) exhausted.) maxRetriesrKr4rr5stoprGr#rrrrQs z(KiteTickerClientFactory.send_noreconnect)r>r?r@rAr protocolmaxDelayrUrHrrJrSrTrQrCrrrrrDs   rDc @s8eZdZdZdddddddd d dd Zd Zd ZdZdZdZ dZ dZ dZ dZ dZdZdZdZdZdddeeefddZddZdd ZdLd!d"Zd#d$ZdMd%d&ZdMd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zd5d6Z d7d8Z!d9d:Z"d;d<Z#d=d>Z$d?d@Z%dAdBZ&dCdDZ'dEdFZ(dNdHdIZ)dJdKZ*dS)O KiteTickera The WebSocket client for connecting to Kite Connect's streaming quotes service. Getting started: --------------- #!python import logging from kiteconnect import KiteTicker logging.basicConfig(level=logging.DEBUG) # Initialise kws = KiteTicker("your_api_key", "your_access_token") def on_ticks(ws, ticks): # Callback to receive ticks. logging.debug("Ticks: {}".format(ticks)) def on_connect(ws, response): # Callback on successful connect. # Subscribe to a list of instrument_tokens (RELIANCE and ACC here). ws.subscribe([738561, 5633]) # Set RELIANCE to tick in `full` mode. ws.set_mode(ws.MODE_FULL, [738561]) def on_close(ws, code, reason): # On connection close stop the event loop. # Reconnection will not happen after executing `ws.stop()` ws.stop() # Assign the callbacks. kws.on_ticks = on_ticks kws.on_connect = on_connect kws.on_close = on_close # Infinite loop on the main thread. Nothing after this will run. # You have to use the pre-defined callbacks to manage subscriptions. kws.connect() Callbacks --------- In below examples `ws` is the currently initialised WebSocket object. - `on_ticks(ws, ticks)` - Triggered when ticks are recevied. - `ticks` - List of `tick` object. Check below for sample structure. - `on_close(ws, code, reason)` - Triggered when connection is closed. - `code` - WebSocket standard close event code (https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) - `reason` - DOMString indicating the reason the server closed the connection - `on_error(ws, code, reason)` - Triggered when connection is closed with an error. - `code` - WebSocket standard close event code (https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) - `reason` - DOMString indicating the reason the server closed the connection - `on_connect` - Triggered when connection is established successfully. - `response` - Response received from server on successful connection. - `on_message(ws, payload, is_binary)` - Triggered when message is received from the server. - `payload` - Raw response from the server (either text or binary). - `is_binary` - Bool to check if response is binary type. - `on_reconnect(ws, attempts_count)` - Triggered when auto reconnection is attempted. - `attempts_count` - Current reconnect attempt number. - `on_noreconnect(ws)` - Triggered when number of auto reconnection attempts exceeds `reconnect_tries`. - `on_order_update(ws, data)` - Triggered when there is an order update for the connected user. Tick structure (passed to the `on_ticks` callback) --------------------------- [{ 'instrument_token': 53490439, 'mode': 'full', 'volume_traded': 12510, 'last_price': 4084.0, 'average_traded_price': 4086.55, 'last_traded_quantity': 1, 'total_buy_quantity': 2356 'total_sell_quantity': 2440, 'change': 0.46740467404674046, 'last_trade_time': datetime.datetime(2018, 1, 15, 13, 16, 54), 'exchange_timestamp': datetime.datetime(2018, 1, 15, 13, 16, 56), 'oi': 21845, 'oi_day_low': 0, 'oi_day_high': 0, 'ohlc': { 'high': 4093.0, 'close': 4065.0, 'open': 4088.0, 'low': 4080.0 }, 'tradable': True, 'depth': { 'sell': [{ 'price': 4085.0, 'orders': 1048576, 'quantity': 43 }, { 'price': 4086.0, 'orders': 2752512, 'quantity': 134 }, { 'price': 4087.0, 'orders': 1703936, 'quantity': 133 }, { 'price': 4088.0, 'orders': 1376256, 'quantity': 70 }, { 'price': 4089.0, 'orders': 1048576, 'quantity': 46 }], 'buy': [{ 'price': 4084.0, 'orders': 589824, 'quantity': 53 }, { 'price': 4083.0, 'orders': 1245184, 'quantity': 145 }, { 'price': 4082.0, 'orders': 1114112, 'quantity': 63 }, { 'price': 4081.0, 'orders': 1835008, 'quantity': 69 }, { 'price': 4080.0, 'orders': 2752512, 'quantity': 89 }] } }, ..., ...] Auto reconnection ----------------- Auto reconnection is enabled by default and it can be disabled by passing `reconnect` param while initialising `KiteTicker`. On a side note, reconnection mechanism cannot happen if event loop is terminated using `stop` method inside `on_close` callback. Auto reonnection mechanism is based on [Exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) algorithm in which next retry interval will be increased exponentially. `reconnect_max_delay` and `reconnect_max_tries` params can be used to tewak the alogrithm where `reconnect_max_delay` is the maximum delay after which subsequent reconnection interval will become constant and `reconnect_max_tries` is maximum number of retries before its quiting reconnection. For example if `reconnect_max_delay` is 60 seconds and `reconnect_max_tries` is 50 then the first reconnection interval starts from minimum interval which is 2 seconds and keep increasing up to 60 seconds after which it becomes constant and when reconnection attempt is reached upto 50 then it stops reconnecting. method `stop_retry` can be used to stop ongoing reconnect attempts and `on_reconnect` callback will be called with current reconnect attempt and `on_noreconnect` is called when reconnection attempts reaches max retries. r r:r ) nsenfocdsbsebfobcdmcxmcxsxindicesbsecds<2zwss://ws.kite.tradefullquoteltpT subscribe unsubscribemodei,FNc Cs|p|j|_||jkrtdj|jd|j|_n||_||jkr1tdj|jd|j|_n||_||_ dj|j||d|_ ||_ d|_ d|_ d|_d|_d|_d|_d|_d|_d|_d|_i|_dS)a Initialise websocket client instance. - `api_key` is the API key issued to you - `access_token` is the token obtained after the login flow in exchange for the `request_token`. Pre-login, this will default to None, but once you have obtained it, you should persist it in a database or session to pass to the Kite Connect class initialisation for subsequent requests. - `root` is the websocket API end point root. Unless you explicitly want to send API requests to a non-default endpoint, this can be ignored. - `reconnect` is a boolean to enable WebSocket autreconnect in case of network failure/disconnection. - `reconnect_max_delay` in seconds is the maximum delay after which subsequent reconnection interval will become constant. Defaults to 60s and minimum acceptable value is 5s. - `reconnect_max_tries` is maximum number reconnection attempts. Defaults to 50 attempts and maximum up to 300 attempts. - `connect_timeout` in seconds is the maximum interval after which connection is considered as timeout. Defaults to 30s. z\`reconnect_max_tries` can not be more than {val}. Setting to highest possible value - {val}.)valz[`reconnect_max_delay` can not be less than {val}. Setting to lowest possible value - {val}.z4{root}?api_key={api_key}&access_token={access_token})rootapi_key access_tokenN)ROOT_URIru_maximum_reconnect_max_triesrwarningr5reconnect_max_tries_minimum_reconnect_max_delayreconnect_max_delayconnect_timeout socket_urlr4ron_ticksr"r*r)rr%rFrGon_order_updatesubscribed_tokens) rrvrwr4ru reconnectr{r}r~rrrrs@      zKiteTicker.__init__cKst|fi||_|jj|_|j|j_|j|j_|j|j_|j|j_ |j |j_ |j |j_ |j|j_|j|j_|j|j_|j|j_dS)z%Create a WebSocket client connection.N)rDrrr4_on_openr" _on_errorr) _on_closer* _on_messager% _on_connectr _on_reconnectrF_on_noreconnectrGr}rXr{rU)rurlrrrr_create_connections          zKiteTicker._create_connectioncCstdtS)Nz-python/)r capitalizer r#rrr _user_agentszKiteTicker._user_agentcCsddi}|j|j|||dd}|jjr|st}t|j||jd|j r.t t j i}tjsW|rMd|d<tjtj|d|_d |j_|jdStjd i|dSdS) aA Establish a websocket connection. - `threaded` is a boolean indicating if the websocket client has to be run in threaded mode or not - `disable_ssl_verification` disables building ssl context - `proxy` is a dictionary with keys `host` and `port` which denotes the proxy settings zX-Kite-Version3) useragentproxyheadersN)contextFactorytimeoutFinstallSignalHandlers)targetrTr)rrrrisSecurerClientContextFactoryr r~r4 twisted_log startLoggingsysstdoutrrunning threadingThreadrunwebsocket_threaddaemonstart)rthreadeddisable_ssl_verificationrrcontext_factoryoptsrrrconnects*   zKiteTicker.connectcCs|jr |jj|jjkr dSdS)z-Check if WebSocket connection is established.TF)rstate STATE_OPENr#rrr is_connectedszKiteTicker.is_connectedcCs|jr |j||dSdSzClose the WebSocket connection.N)r sendCloserr1r2rrr_close"szKiteTicker._closecCs||||dSr) stop_retryrrrrrclose'szKiteTicker.closecCs tdS)zStop the event loop. Should be used if main thread has to be closed in `on_close` method. Reconnection mechanism cannot happen past this method N)rrVr#rrrrV,s zKiteTicker.stopcCs|jr |jdSdS)z'Stop auto retry when it is in progress.N)r stopTryingr#rrrr2szKiteTicker.stop_retryc Csnz|jtt|j|d|D]}|j|j|<qWdSt y6}z |j d t |dd}~ww)z Subscribe to a list of instrument_tokens. - `instrument_tokens` is list of instrument instrument_tokens to subscribe avTzError while subscribe: {}r2N) r sendMessagesixbjsondumps_message_subscribe MODE_QUOTEr Exceptionrr5strrinstrument_tokenstokenerrrrq7szKiteTicker.subscribec Csz'|jtt|j|d|D]}z|j|=Wqty$YqwWdSt y?}z |j d t |dd}~ww)z Unsubscribe the given list of instrument_tokens. - `instrument_tokens` is list of instrument_tokens to unsubscribe. rTzError while unsubscribe: {}rN) rrrrrr_message_unsubscriberKeyErrorrrr5rrrrrrrJs   zKiteTicker.unsubscribec Cspz|jtt|j||gd|D]}||j|<qWdSty7}z |j d t |dd}~ww)a' Set streaming mode for the given list of tokens. - `mode` is the mode to set. It can be one of the following class constants: MODE_LTP, MODE_QUOTE, or MODE_FULL. - `instrument_tokens` is list of instrument tokens on which the mode should be applied rTzError while setting mode: {}rN) rrrrrr_message_setmoderrrr5r)rrsrrrrrrset_mode`s zKiteTicker.set_modecCsi}|jD]}|j|}||sg||<|||q|D]}|jr/td||||||||||qdS)z-Resubscribe to all current subscribed tokens.z!Resubscribe and set mode: {} - {}N)rgetappendr4rr5rqr)rmodesrmrsrrr resubscribevs   zKiteTicker.resubscribecCs ||_|jr|||dSdSN)rr)rrrrrrrszKiteTicker._on_connectcC2td|t||jr||||dSdS)z3Call `on_close` callback when connection is closed.zConnection closed: {} - {}N)rrLr5rr*rrr1r2rrrrzKiteTicker._on_closecCr)z9Call `on_error` callback when connection throws an error.zConnection error: {} - {}N)rrLr5rr)rrrrrrzKiteTicker._on_errorcCsR|jr |||||jr|rt|dkr|||||s'||dSdS)z9Call `on_message` callback when text message is received.r[N)r%rlen _parse_binary_parse_text_message)rrr&r'rrrrszKiteTicker._on_messagecCs(|js|d|_|jr||SdS)NF)_is_first_connectrr")rrrrrrs  zKiteTicker._on_opencCs|jr |||SdSr)rF)rattempts_countrrrrs zKiteTicker._on_reconnectcCs|jr||SdSr)rGr#rrrrs zKiteTicker._on_noreconnectcCstjst|tkr|d}zt|}Wn tyYdSw|jr7| ddkr7| dr7|||d| ddkrJ| |d| ddSdS)zParse text message.zutf-8NtypeorderdatarLr) rPY2rbytesdecoderloads ValueErrorrrr)rr&rrrrrs  zKiteTicker._parse_text_messagecCs.||}g}|D] }||dd}|d@}||jdkr!d}n ||jdkr+d}nd}||jd kr6d nd }t|d krQ|||j|||dd |d q t|dks]t|dkrt|dkrf|jn|j} || |||dd |||d d|||dd|||dd|||dd|dd} d| d<| dddkr| d| ddd| dd| d<t|dkrz t ||dd} Wn t yd} Ynw| | d<|| q t|dkst|dkrt|dkr|jn|j} || |||dd |||d d||dd|||dd||dd||dd||dd|||dd|||dd |||d d|d!d" } d| d<| dddkrk| d| ddd| dd| d<t|dkrz t ||dd#} Wn t yd} Ynwz t ||d$d%} Wn t yd} Ynw| | d&<||d#d'| d(<||d'd)| d*<||d)d$| d+<| | d<ggd,} t t d%t|dD]4\}}| |d-krd.nd/||||d|||d|d ||j||d |d0d1d2d3q| | d4<|| q |S)5z1Parse binary data to a (list of) ticks structure.rr[rbgcAreg@gY@rhFTr^)tradablersinstrument_token last_price )highlowopenr)rrsrrohlcchangerrrdNexchange_timestamp,$()rrrr) rrsrrlast_traded_quantityaverage_traded_price volume_tradedtotal_buy_quantitytotal_sell_quantityr0rk@last_trade_time4oi8 oi_day_high oi_day_low)buysellrrrrEH byte_format)quantitypriceordersdepth) _split_packets _unpack_int EXCHANGE_MAPrrMODE_LTPr MODE_FULLr fromtimestampr enumeraterange)rbinpacketsrpacketrsegmentdivisorrrsd timestamprriprrrrs    (       (  zKiteTicker._parse_binaryIcCstd||||dS)z(Unpack binary data as unsgined interger.>r)structunpack)rrrendrrrrr LszKiteTicker._unpack_intcCs|t|dkrgS|j|dddd}g}d}t|D]"}|j|||ddd}|||d|d||d|}q|S)z.Split the data to individual packets of ticks.r:rrr)rr rr)rrnumber_of_packetsrjr packet_lengthrrrr Ps  zKiteTicker._split_packets)FFN)NN)r)+r>r?r@rAr CONNECT_TIMEOUTRECONNECT_MAX_DELAYRECONNECT_MAX_TRIESrxr rr r _message_coderrrr|ryrrrrrrrrVrrqrrrrrrrrrrrrrr r rrrrrYsn E +     } rY)rArrr6rrloggingrrtwisted.internetrrtwisted.pythonrrtwisted.internet.protocolrautobahn.twisted.websocketrrr r r getLoggerr>r rDobjectrYrrrrs$    mB