8'h~dZddlZddlZddlZddlZddlZddlZddlZddlmZddl m Z m Z ddl m ZddlmZddlmZmZmZdd lmZmZej.eZ Gd d eZGd d eeZGddeZy)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__cfeZdZdZdZdZdZdZdZdZ fdZ dZ dZ dZ d Zd Z d Zd ZxZS) KiteTickerClientProtocolz(Kite ticker autobahn WebSocket protocol.g@Nc,tt| |i|y)z9Initialize protocol with all options passed from factory.N)superr__init__selfargskwargs __class__s N/var/www/html/trade_iq/venv/lib/python3.12/site-packages/kiteconnect/ticker.pyrz!KiteTickerClientProtocol.__init__(s &6GGc||j_|jjr|jj|||jjy)z7Called when WebSocket server connection was establishedN)factoryws on_connect resetDelayrresponses r onConnectz"KiteTickerClientProtocol.onConnect-s@  << " " LL # #D( 3 !rc|j|j|jjr|jj|yy)zBCalled when the initial WebSocket opening handshake was completed.N) _loop_ping_loop_pong_checkron_openrs ronOpenzKiteTickerClientProtocol.onOpen8s>   <<   LL  & rcl|jjr|jj|||yy)z/Called when text or binary message is received.N)r on_message)rpayload is_binarys r onMessagez"KiteTickerClientProtocol.onMessageCs* << " " LL # #D'9 = #rc|s3|jjr|jj||||jjr|jj|||d|_d|_|j r|j j |jr|jj yy)z!Called when connection is closed.N)ron_erroron_close_last_ping_time_last_pong_time _next_pingcancel_next_pong_check)r was_cleancodereasons ronClosez KiteTickerClientProtocol.onCloseIs||$$ %%dD&9 << LL ! !$f 5 $# ?? OO " " $   ! ! ( ( * !rcv|jrY|jjrCtjdj t j |jz t j |_|jjr%tjdj |yy)z%Called when pong message is received.zlast pong was {} seconds back.z pong => {}N)r2rdebugrformattimer s ronPongzKiteTickerClientProtocol.onPong\sw   DLL$6$6 II6==diikDL`L`>`a b#yy{ <<   IIl))(3 4 rc~|jjrO|jrCtjdj t j |jz t j |_|jj j|j|j|_ y)z>Start a ping loop where it sends ping message every X seconds.zlast ping was {} seconds back.N) rr;r1rr<r=r callLater PING_INTERVALr$r3r's rr$z#KiteTickerClientProtocol._loop_pingjs| <<  ## :AA$))+PTPdPdBdef $yy{,,..889K9KT__]rc|jrtj|jz }|d|jzkDrL|jjr$t j dj ||jd|jjj|j|j|_ y)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) r2r=rArr;rr<dropConnectionrr@r%r5)rlast_pong_diffs rr%z)KiteTickerClientProtocol._loop_pong_checkvs   !YY[4+?+??NT%7%7!78<<%%IIbii&()##$#/!% 4 4 > >t?Q?QSWShSh ir)__name__ __module__ __qualname____doc__rAKEEPALIVE_INTERVALr3r5r2r1rr"r(r-r9r>r$r% __classcell__rs@rrrsV2MJOOH "'> +&5 ^jrrcJeZdZdZeZdZdZdZfdZ dZ dZ dZ d Z xZS) KiteTickerClientFactoryzQAutobahn WebSocket client factory to implement reconnection and custom callbacks.r Ncd|_d|_d|_d|_d|_d|_d|_d|_d|_tt|.|i|y)z/Initialize with default callback method values.FN) r;rr&r/r0r*r on_reconnecton_noreconnectrrOrrs rrz KiteTickerClientFactory.__init__sY     " %t5tFvFrc|js!|jrtjdtj|_y)z$On connecting start or reconnection.zStart WebSocket connection.N)_last_connection_timer;rr=)r connectors rstartedConnectingz)KiteTickerClientFactory.startedConnectings,))djj II3 4%)YY["rc H|jdkDrrtjdj|jt t |j |jr|j|j|j||jy)z2On connection failure (When connect request fails)rzNRetrying connection. Retry attempt count: {}. Next retry in around: {} secondsN) retriesrerrorr<introunddelayrRretrysend_noreconnectrrVr8s rclientConnectionFailedz.KiteTickerClientFactory.clientConnectionFaileds <On connection lost (When ongoing connection got disconnected).rN)rYrRr^r_r`s rclientConnectionLostz,KiteTickerClientFactory.clientConnectionLostsC <tjdj |j|j |j r|j yyyy)z5Callback `no_reconnect` if max retries are exhausted.NzMaximum retries ({}) exhausted.) maxRetriesrYr;rr<stoprSr's rr_z(KiteTickerClientFactory.send_noreconnectsj ?? &DLL4??,Jzz ;BB4??ST ""##%# -K &r)rGrHrIrJrprotocolmaxDelayrerUrrWrarcr_rLrMs@rrOrOs5['HHJ  G1     &rrOc eZdZdZdddddddd d dd Zd Zd ZdZdZdZ dZ dZ dZ dZ dZdZdZdZdZdddeeefdZdZdZd3dZdZd4d Zd4d!Zd"Zd#Zd$Zd%Zd&Zd'Zd(Z d)Z!d*Z"d+Z#d,Z$d-Z%d.Z&d/Z'd0Z(d5d1Z)d2Z*y)6 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 rCr ) nsenfocdsbsebfobcdmcxmcxsxindicesbsecds<2zwss://ws.kite.tradefullquoteltpT subscribe unsubscribemodei,FNc |xs |j|_||jkDrAtj dj |j|j|_n||_||jkrAtj dj |j|j|_n||_||_ dj |j|||_ ||_ d|_ d|_ d|_d|_d|_d|_d|_d|_d|_d|_i|_y)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_URIr_maximum_reconnect_max_triesrwarningr<reconnect_max_tries_minimum_reconnect_max_delayreconnect_max_delayconnect_timeout socket_urlr;ron_ticksr&r0r/rr*rRrSon_order_updatesubscribed_tokens) rrrr;r reconnectrrrs rrzKiteTicker.__init__sD()DMM  !B!B B KKv}}55~7 8'+'H'HD $':D $ !B!B B KKu||55}7 8'+'H'HD $':D $.++16YY),2,       " $"$rc xt|fi||_|jj|_|j|j_|j|j_|j |j_|j|j_ |j|j_ |j|j_ |j|j_|j |j_|j$|j_|j(|j_y)z%Create a WebSocket client connection.N)rOrrr;_on_openr& _on_errorr/ _on_closer0 _on_messager* _on_connectr _on_reconnectrR_on_noreconnectrSrrhrre)rurlrs r_create_connectionzKiteTicker._create_connections.s=f= ,,//!ZZ  $}}  $  $ "&"2"2 "&"2"2 $($6$6 !&*&:&: # $ 8 8 "&":": rc>tdzjtzS)Nz-python/)r capitalizer r's r _user_agentzKiteTicker._user_agentsJ&224{BBrcnddi}|j|j|j||d}|jjr|st j }t|j||j|jr#tjtji}tjss|r[d|d<t!j"tj$||_d |j&_|j&j+ytj$d i|yy) 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)targetrT)rrrrisSecurerClientContextFactoryr rr; twisted_log startLoggingsysstdoutrrunning threadingThreadrunwebsocket_threaddaemonstart)rthreadeddisable_ssl_verificationrrcontext_factoryoptss rconnectzKiteTicker.connects c  *.*:*:*<&+W  >  << )A!668O $,,H\H\] ::  $ $SZZ 005,-(1(8(8 TX(Y%/3%%,%%++- #d#rcx|jr.|jj|jjk(ryy)z-Check if WebSocket connection is established.TF)rstate STATE_OPENr's r is_connectedzKiteTicker.is_connecteds( 77tww}}(:(::rcV|jr|jj||yyzClose the WebSocket connection.N)r sendCloserr7r8s r_closezKiteTicker._close"s" 77 GG  dF + rcH|j|j||yr) stop_retryrrs rclosezKiteTicker.close's  D&!rc,tjy)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)rrfr's rrfzKiteTicker.stop,s   rcR|jr|jjyy)z'Stop auto retry when it is in progress.N)r stopTryingr's rrzKiteTicker.stop_retry2s << LL # # % rc Z |jjtjt j |j |d|D]}|j|j|<y#t$r0}|jdjt|d}~wwxYw)z Subscribe to a list of instrument_tokens. - `instrument_tokens` is list of instrument instrument_tokens to subscribe avTzError while subscribe: {}r8N) r sendMessagesixbjsondumps_message_subscribe MODE_QUOTEr Exceptionrr<strrinstrument_tokenstokenes rrzKiteTicker.subscribe7s  GG  djjt'>'>EV!WXY + @04&&u- @  KK:AA#a&IK J  sA.A11 B*:+B%%B*c b |jjtjt j |j |d|D]} |j|=y#t$rYwxYw#t$r0}|jdjt|d}~wwxYw)z Unsubscribe the given list of instrument_tokens. - `instrument_tokens` is list of instrument_tokens to unsubscribe. rTzError while unsubscribe: {}rN) rrrrrr_message_unsubscriberKeyErrorrrr<rrs rrzKiteTicker.unsubscribeJs   GG  djjt'@'@GX!YZ[ + //6     KK<CCCFKK L  s<AA5 A&#A5& A2/A51A22A55 B.>+B))B.c J |jjtjt j |j ||gd|D]}||j|<y#t$r0}|jdjt|d}~wwxYw)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_setmoderrrr<r)rrrrrs rset_modezKiteTicker.set_mode`s  GG  djjt'<': : rc>|jr|j|Syr)rSr's rrzKiteTicker._on_noreconnects!   &&t, , rctjs#t|tk(r|j d} t j |}|jr:|jddk(r&|jdr|j||d|jddk(r#|j|d|jdyy#t$rYywxYw)zParse text message.zutf-8NtypeorderdatarZr) rPY2rbytesdecoderloads ValueErrorrrr)rr+rs rrzKiteTicker._parse_text_messagesww4=E1nnW-G ::g&D   DHHV$4$?DHHVDT  tF| 4 88F w & NN4DHHV$4 5 '   sC CCc` |j|}g}|D]^}|j|dd}|dz}||jdk(rd}n||jdk(rd}nd}||jd k(rd nd }t|d k(r5|j ||j ||j|dd |z d t|dk(st|dk(rt|dk(r |j n |j} || ||j|dd |z |j|d d|z |j|dd|z |j|dd|z |j|dd|z dd} d| d<| dddk7r| d| ddz dz| ddz | d<t|dk(r, tj|j|dd} | | d<|j | t|dk(st|dk(st|dk(r |j n |j} || ||j|dd |z |j|d d|j|dd|z |j|dd|j|dd|j|dd|j|dd|z |j|dd|z |j|dd |z |j|d d|z d!d" } d| d<| dddk7r| d| ddz dz| ddz | d<t|dk(r1 tj|j|dd#} tj|j|d$d%} | | d&<|j|d#d'| d(<|j|d'd)| d*<|j|d)d$| d+<| | d<ggd,} ttd%t|dD]k\}}| |d-k\rd.nd/j |j|||dz|j||dz|d z|z |j||d z|d0zd12d3m| | d4<|j | a|S#t$rd} YwxYw#t$rd} Y@wxYw#t$rd} Y+wxYw)5z1Parse binary data to a (list of) ticks structure.rrlrsgcArvg@gY@ryFTro)tradablerinstrument_token last_price )highlowopenr)rrrrohlcchangerrrdNexchange_timestamp,$()rrrr) rrrrlast_traded_quantityaverage_traded_price volume_tradedtotal_buy_quantitytotal_sell_quantityr0r|@last_trade_time4oi8 oi_day_high oi_day_low)buysellrr'r&rPH byte_format)quantitypriceordersdepth) _split_packets _unpack_int EXCHANGE_MAPrrMODE_LTPr MODE_FULLr fromtimestampr enumeraterange)rbinpacketsrpacketrsegmentdivisorrrd timestampr r.ips rrzKiteTicker._parse_binarysd%%c*t F#//1= &-G$++E22$D--e44!!(4+<+AdG'+'7'7B'GAm$&*&6&6vr2&FAlO.7A*+ " "E !*%CK*D E1QfE:AA(,(8(8AE(J%)%5%5fa!eQU%Kg%U&*&6&6vq1ua"fZ]&6&^C"'AgJ Ait l K%)$( )J%/*./ %)$( )s6'&Q:4&R &R: R R  RR R-,R-c@tjd|z|||dS)z(Unpack binary data as unsgined interger.>r)structunpack)rr7rendr*s rr0zKiteTicker._unpack_intLs#}}S;.E#?BBrct|dkrgS|j|ddd}g}d}t|D]?}|j|||dzd}|j||dz|dz|z|dz|z}A|S)z.Split the data to individual packets of ticks.rCrr(r))rr0r6r)rr7number_of_packetsr8jr> packet_lengths rr/zKiteTicker._split_packetsPs s8a<I ,,S!QC,H () &A ,,S!QU,LM NN3q1ua!em&;< =A %A & r)FFN)NN)I)+rGrHrIrJr1CONNECT_TIMEOUTRECONNECT_MAX_DELAYRECONNECT_MAX_TRIESrr3rr2r _message_coderrrrrrrrrrrrrfrrrrrrrrrrrrrrr0r/rrrrjrjsXv L O%HIJHM$($% #& 495H^q!0C$J;*C)$V, "  & &,,-&, .. . &;-6&{zCrrj)rJrrr=rrBloggingrrtwisted.internetrrtwisted.pythonrrtwisted.internet.protocolrautobahn.twisted.websocketrr r r r getLoggerrGrrOobjectrjrrrrUs )-?&&0g!jj6jjZ?&46O?&DS S r