btgsolutions-dataservices-python-client 2.10.1__py3-none-any.whl → 2.11.4__py3-none-any.whl

btgsolutions_dataservices/config.py

@@ -53,6 +53,10 @@ VALID_MARKET_DATA_TYPES = [
 ]
 VALID_MARKET_DATA_SUBTYPES = [ALL, STOCKS, OPTIONS, DERIVATIVES]
 
+FEED_A = "A"
+FEED_B = "B"
+VALID_FEEDS = [FEED_A, FEED_B]
+
 market_data_socket_urls = {
     B3: {
         TRADES: {

btgsolutions_dataservices/rest/historical_candles.py

@@ -158,4 +158,32 @@ class HistoricalCandles:
             return response_data if raw_data else pd.DataFrame(response_data)
 
         response = json.loads(response.text)
-        raise BadResponse(f'Error: {response.get("ApiClientError", "")}.\n{response.get("SuggestedAction", "")}')
+        raise BadResponse(f'Error: {response.get("ApiClientError", "")}.\n{response.get("SuggestedAction", "")}')
+
+    def get_available_tickers(
+        self,
+        market_type:str,
+        date:str,
+    ):
+        """
+        This method provides all tickers available for query.   
+
+        Parameters
+        ----------------
+        market_type: str
+            Market type.
+            Options: 'stocks', 'derivatives' or 'indices'.
+            Field is required.
+        date: string<date>
+            Date of requested data. Format: "YYYY-MM-DD".
+            Field is required. Example: '2023-10-06'.
+        """
+
+        if market_type not in ['stocks', 'derivatives', 'indices']: raise MarketTypeError(f"Must provide a valid 'market_type' parameter. Input: '{market_type}'. Accepted values: 'stocks', 'derivatives' or 'indices'.")
+
+        url = f"{url_apis_v3}/marketdata/history/candles/available-tickers/{market_type}?date={date}"
+
+        response = requests.request("GET", url,  headers=self.headers)
+        if response.status_code == 200: return response.json()
+        response = response.json()
+        raise BadResponse(f'Error: {response.get("ApiClientError", "") or response.get("ApiServerMessage", "")}.\n{response.get("SuggestedAction", "")}')

btgsolutions_dataservices/websocket/__init__.py

@@ -1,2 +1,3 @@
 from .market_data_websocket_client import MarketDataWebSocketClient
-from .hfn_websocket_client import HFNWebSocketClient
+from .hfn_websocket_client import HFNWebSocketClient
+from .market_data_feed import MarketDataFeed

btgsolutions_dataservices/websocket/market_data_feed.py

@@ -0,0 +1,315 @@
+from typing import Optional, Callable, List
+import websocket
+import time
+from datetime import date
+import multiprocessing
+import logging
+from logging.handlers import QueueHandler, QueueListener
+import json
+import ssl
+import threading
+from ..rest import Authenticator
+from ..config import market_data_socket_urls, market_data_feedb_socket_urls, REALTIME, B3, TRADES, BOOKS, FEED_A, FEED_B, MAX_WS_RECONNECT_RETRIES
+from .websocket_default_functions import _on_open, _on_message_already_serialized, _on_error, _on_close
+
+multiprocessing.set_start_method("spawn", force=True)
+
+class MarketDataFeed:
+    """
+    WebSocket client that connects with BTG Solutions Data Services WebSocket servers. The servers streams realtime and delayed market data, such as trades and book events.
+    This is a multiprocessing-based WebSocket client designed for high-performance, scalable message handling applications. It leverages a system of inter-process communication to efficiently separate concerns and prevent the main application thread from blocking during WebSocket operations or message processing.
+
+    * Main use case:
+
+    >>> from btgsolutions_dataservices import MarketDataFeed
+    >>> ws = MarketDataFeed(
+    >>>     api_key='YOUR_API_KEY',
+    >>>     stream_type='realtime',
+    >>>     exchange='b3',
+    >>>     data_type='trades',
+    >>>     data_subtype='stocks',
+    >>>     ssl=True
+    >>> )
+    >>> ws.run()
+    >>> ws.subscribe(['MGLU3'])
+    >>> ws.unsubscribe(['PETR4'])
+    >>> ws.close()
+
+    Parameters
+    ----------------
+    api_key: str
+        User identification key.
+        Field is required.
+    stream_type: str
+        Websocket connection feed.
+        Options: 'realtime', 'delayed'.
+        Field is not required. Default: 'realtime'.
+    exchange: str
+        Exchange name.
+        Options: 'b3' or 'bmv'.
+        Field is not required. Default: 'b3'.
+    data_type: str
+        Market Data type.
+        Options: 'trades', 'processed-trades', 'books', 'indices', 'securities', 'stoploss', 'candles-1S', 'candles-1M', 'instrument_status'.
+        Field is not required. Default: 'trades'.
+    data_subtype: str
+        Market Data subtype (when applicable).
+        Options: 'stocks', 'options', 'derivatives'.
+        Field is not required. Default: None.
+    feed: str
+        Market Data Feed.
+        Options: 'A', 'B'.
+        Field is not required. Default: 'A' (enable).
+    ssl: bool
+        Enable or disable ssl configuration.
+        Field is not required. Default: True (enable).
+    reconnect: bool
+        Try reconnect if connection is closed.
+        Field is not required.
+        Default: True.
+    on_open: function
+        - Called at opening connection to websocket.
+        - Field is not required. 
+        - Default: prints that the connection was opened in case of success.
+    on_message: function
+        - Called every time it receives a message.
+        - Arguments:
+            1. Data received from the server.
+        - Field is not required. 
+        - Default: prints the data.
+    on_error: function
+        - Called when a error occurs.
+        - Arguments: 
+            1. Exception object.
+        - Field is not required. 
+        - Default: prints the error.
+    on_close: function
+        - Called when connection is closed.
+        - Arguments: 
+            1. close_status_code.
+            2. close_msg.
+        - Field is not required. 
+        - Default: prints a message that the connection was closed.
+    log_level: str
+        Log level sets how much information the program will print to the log file.
+        Options: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL', 'NOTSET'.
+        'DEBUG' provides the most detailed logs, with verbosity decreasing through each level down to 'NOTSET', which disables all logging.
+        Field is not required. Default: 'DEBUG'.
+    """
+
+    def __init__(
+        self, 
+        api_key: str,
+        stream_type: Optional[str]=REALTIME,
+        exchange: Optional[str]=B3,
+        data_type: Optional[str]=TRADES,
+        data_subtype: Optional[str]=None,
+        feed: Optional[str]=FEED_A,
+        ssl: Optional[bool]=True,
+        reconnect: bool=True,
+        on_open: Optional[Callable]=None,
+        on_message: Optional[Callable]=None,
+        on_error: Optional[Callable]=None,
+        on_close: Optional[Callable]=None,
+        log_level: str="DEBUG",
+    ):
+
+        if feed == FEED_B:
+            url_feed_map = market_data_feedb_socket_urls
+        else:
+            url_feed_map = market_data_socket_urls
+
+        try:
+            self.url = url_feed_map[exchange][data_type][stream_type][data_subtype]
+        except:
+            raise Exception(f"There is no WebSocket type for your specifications (stream_type:{stream_type}, exchange:{exchange}, data_type:{data_type}, data_subtype:{data_subtype})\nPlease check your request parameters and try again")
+        
+        self.__authenticator = Authenticator(api_key)
+
+        self.data_type = data_type
+        self.on_open = _on_open if on_open is None else on_open
+        self.on_message = _on_message_already_serialized if on_message is None else on_message
+        self.on_error = _on_error if on_error is None else on_error
+        self.on_close = _on_close if on_close is None else on_close
+        
+        self.ssl = ssl
+        self.reconnect = reconnect
+        self.__nro_reconnect_retries = 0
+
+        self.server_message_queue = multiprocessing.Queue()
+        self.client_message_queue = multiprocessing.Queue()
+        self.log_queue = multiprocessing.Queue()
+
+        log_level = getattr(logging, log_level)
+        self.log_level = log_level
+
+        log_handler = logging.FileHandler(filename=f"MarketDataFeed_{date.today().isoformat()}.log")
+        log_handler.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s - %(message)s'))
+
+        log_queue_listener = QueueListener(self.log_queue, log_handler)
+        log_queue_listener.start()
+
+        self.logger = logging.getLogger("main")
+        self.logger.setLevel(log_level)
+        self.logger.addHandler(QueueHandler(self.log_queue))
+
+        self.process = None
+        self.running = False
+
+    def _ws_client_process(self, server_message_queue: multiprocessing.Queue, client_message_queue: multiprocessing.Queue, log_queue: multiprocessing.Queue, log_level: int):
+
+        logger = logging.getLogger("client")
+        logger.setLevel(log_level)
+        logger.addHandler(QueueHandler(log_queue))
+
+        def on_message(ws, message):
+            server_message_queue.put(json.loads(message))
+
+        def on_error(ws, error):
+            logger.error(f"On Error | {error}")
+            self.on_error(error)
+
+        def on_close(ws, close_status_code, close_msg):
+            logger.warning(f"On Close | Connection closed")
+            self.on_close(close_status_code, close_msg)
+            if self.reconnect:
+                if self.__nro_reconnect_retries == MAX_WS_RECONNECT_RETRIES:
+                    logger.critical(f"On Close | Maximum number of reconnect attempts reached")
+                    return
+                self.__nro_reconnect_retries += 1
+                logger.warning(f"On Close | Reconnecting... attempt: {self.__nro_reconnect_retries}/{MAX_WS_RECONNECT_RETRIES}")
+                run_forever_new_thread()
+
+        def on_open(ws):
+            logger.info(f"On Open | Connection open")
+            self.on_open()
+            self.__nro_reconnect_retries = 0
+
+        ws = websocket.WebSocketApp(
+            url=self.url,
+            on_open=on_open,
+            on_message=on_message,
+            on_error=on_error,
+            on_close=on_close,
+            header={
+                "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.54 Safari/537.36",
+                "Sec-WebSocket-Protocol": self.__authenticator.token,
+            }
+        )
+
+        def run_forever_new_thread():
+            ssl_conf = {} if self.ssl else {"sslopt": {"cert_reqs": ssl.CERT_NONE}}
+            t = threading.Thread(target=ws.run_forever, kwargs=ssl_conf)
+            t.daemon = True
+            t.start()
+
+            while True:
+                if ws.sock is not None and ws.sock.connected:
+                    break
+                pass
+
+            while True:
+                try:
+                    if not client_message_queue.empty():
+                        msg = client_message_queue.get()
+                        ws.send(json.dumps(msg))
+                    else:
+                        time.sleep(0.05)
+                except Exception as e:
+                    time.sleep(0.1)
+
+        run_forever_new_thread()
+
+    def run(self):
+        """
+        Opens a new connection with the websocket server.
+        """
+        self.process = multiprocessing.Process(target=self._ws_client_process, args=(self.server_message_queue, self.client_message_queue, self.log_queue, self.log_level))
+        self.process.start()
+        self.running = True
+
+        def run_on_new_thread(*args):
+            log_timer = time.time()
+            while self.running:
+                if not self.server_message_queue.empty():
+                    msg = self.server_message_queue.get()
+                    self.on_message(msg)
+                else:
+                    time.sleep(0.01)
+
+                if time.time() - log_timer >= 5.0:
+                    server_queue_size = self.server_message_queue.qsize()
+                    client_queue_size = self.client_message_queue.qsize()
+                    self.logger.debug(f"Server queue: {server_queue_size} | Client queue: {client_queue_size}")
+                    log_timer = time.time()
+        
+        threading.Thread(target=run_on_new_thread).start()
+
+    def close(self):
+        """
+        Closes the connection with the websocket server.
+        """
+        self.running = False
+        if self.process and self.process.is_alive():
+            self.process.terminate()
+            self.process.join()
+
+    def _send(self, message):
+        """
+        Sends a message to the websocket server.
+        """
+        if not isinstance(message, str):
+            message = json.dumps(message)
+        self.client_message_queue.put(json.loads(message))
+
+    def subscribe(self, list_instruments: List[str], n=None):
+        """
+        Subscribes a list of instruments.
+
+        Parameters
+        ----------
+        list_instruments: list
+            Field is required.
+        n: int
+            Field is not required.
+            **For books data_type only.**
+            Maximum book level. It must be between 1 and 10.    
+        """
+        if self.data_type == BOOKS and n is not None:
+            self._send({'action': 'subscribe', 'params': {"tickers": list_instruments, "n": n}})
+        else:
+            self._send({'action': 'subscribe', 'params': list_instruments})
+
+    def unsubscribe(self, list_instruments: List[str]):
+        """
+        Unsubscribes a list of instruments.
+
+        Parameters
+        ----------
+        list_instruments: list
+            Field is required.
+        """
+        self._send({'action': 'unsubscribe', 'params': list_instruments})
+    
+    def subscribed_to(self):
+        """
+        Return client subscribed tickers.
+        """
+        self._send({'action': 'subscribed_to'})
+
+    def available_to_subscribe(self):
+        """
+        Return avaiable tickers to subscribe.
+        """
+        self._send({'action': 'available_to_subscribe'})
+
+    def get_last_event(self, ticker: str):
+        """
+        Get the last event for the provided ticker.
+
+        Parameters
+        ----------
+        ticker: str
+            Field is required.
+        """
+        self._send({'action': 'get_last_event', 'params': ticker})

btgsolutions_dataservices/websocket/market_data_websocket_client.py

@@ -2,7 +2,7 @@
 from typing import Optional, List
 from ..exceptions import WSTypeError, DelayedError, FeedError
 from ..rest import Authenticator
-from ..config import market_data_socket_urls, market_data_feedb_socket_urls, MAX_WS_RECONNECT_RETRIES, VALID_STREAM_TYPES, VALID_EXCHANGES, VALID_MARKET_DATA_TYPES, VALID_MARKET_DATA_SUBTYPES, REALTIME, B3, TRADES, INDICES, ALL, STOCKS, BOOKS
+from ..config import market_data_socket_urls, market_data_feedb_socket_urls, MAX_WS_RECONNECT_RETRIES, VALID_STREAM_TYPES, VALID_EXCHANGES, VALID_MARKET_DATA_TYPES, VALID_MARKET_DATA_SUBTYPES, REALTIME, B3, TRADES, INDICES, ALL, STOCKS, BOOKS, FEED_A, FEED_B
 from .websocket_default_functions import _on_open, _on_message, _on_error, _on_close
 import websocket
 import json
@@ -80,7 +80,7 @@ class MarketDataWebSocketClient:
         data_subtype: Optional[str] = None,
         instruments: Optional[List[str]] = [],
         ssl: Optional[bool] = True,
-        feed: Optional[str] = "A",
+        feed: Optional[str] = FEED_A,
         **kwargs,
     ):
         self.api_key = api_key
@@ -114,7 +114,7 @@ class MarketDataWebSocketClient:
             raise FeedError(
                 f"Must provide a valid 'data_subtype' parameter. Valid options are: {VALID_MARKET_DATA_SUBTYPES}")
 
-        if feed == "B":
+        if feed == FEED_B:
             url_feed_map = market_data_feedb_socket_urls
         else:
             url_feed_map = market_data_socket_urls

btgsolutions_dataservices/websocket/websocket_default_functions.py

@@ -1,5 +1,8 @@
 import json 
 
+def _on_message_already_serialized(message):
+    print(message)
+
 def _on_message(message):
     print(json.loads(message))
 

{btgsolutions_dataservices_python_client-2.10.1.dist-info → btgsolutions_dataservices_python_client-2.11.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: btgsolutions-dataservices-python-client
-Version: 2.10.1
+Version: 2.11.4
 Summary: Python package containing several classes and data for extracting and manipulating market and trading data.
 Home-page: https://github.com/BTG-Pactual-Solutions/btgsolutions-dataservices-python-client
 Author: BTG Solutions Data Services powered by BTG Pactual Solutions
@@ -21,9 +21,9 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-# BTG Solutions - Data Service
+# BTG Solutions - Data Services
 
-Python library to get Brazilian Financial Market Data.
+Real time and historical Financial Market Data, News, Corporate Events and more.
 
 ## Installation
 
@@ -31,61 +31,62 @@ Python library to get Brazilian Financial Market Data.
 pip3 install btgsolutions-dataservices-python-client
 ```
 
+## Documentation
+
+The official documentation is hosted at https://python-client-docs.dataservices.btgpactualsolutions.com/
+
 ## Examples
 
-### WebSocket Books
+### Real Time Data
+
+#### Market Data Stream (optimized for performance)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='books', instruments=['PETR4', 'VALE3'])
-ws.run(on_message=lambda message: print(message))
+ws = btg.MarketDataFeed(api_key='YOUR_API_KEY', data_type='books', data_subtype='stocks')
+ws.run()
+ws.subscribe(['PETR4'])
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
-
-## Another examples
-# ws.available_to_subscribe()
 ```
 
-### WebSocket Trades Delayed
+#### Market Data Stream
+
+##### Books
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='trades', stream_type='delayed', instruments=['PETR4', 'VALE3'])
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='books', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
-
-## Another examples
-# ws.available_to_subscribe()
 ```
 
-### WebSocket Trades with 1 second throttle
+##### Books, Top Of Book (n=1)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='trades', stream_type='throttle', instruments=['PETR4', 'VALE3'])
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='books')
 ws.run(on_message=lambda message: print(message))
+ws.subscribe(['PETR4', 'VALE3'], n=1)
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
-
-## Another examples
-# ws.available_to_subscribe()
 ```
 
-### WebSocket Securities (Derivatives)
+##### Trades
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='securities', data_subtype='derivatives')
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='trades', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
 
 ## The following is optional to keep the program running in a .py file:
@@ -94,32 +95,25 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-### WebSocket Candles 1S
+##### Trades, delayed (15 minutes delay)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='candles-1S', stream_type='realtime')
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='trades', stream_type='delayed', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
-ws.candle_subscribe(list_instruments=['PETR4','VALE3'], candle_type='partial')
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
-
-## Another examples
-# ws.candle_subscribe(list_instruments=['PRIO3'], candle_type='closed')
-# ws.candle_subscribe(list_instruments=['WEGE3'], candle_type='all')
-# ws.candle_unsubscribe(list_instruments=['PRIO3', 'PETR4'], candle_type='all')
 ```
 
-### WebSocket NASDAQ (US) Trades
+##### Trades, throttle (1 second throttle)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', exchange='nasdaq', data_type='trades')
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='trades', stream_type='throttle', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
-ws.subscribe(['AMZN', 'GOOG', 'TSLA'])
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
@@ -127,12 +121,13 @@ ws.subscribe(['AMZN', 'GOOG', 'TSLA'])
 #   sleep(1)
 ```
 
-### WebSocket BMV (MX) Trades
+##### Trades, NASDAQ (US)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', exchange='bmv', data_type='trades')
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', exchange='nasdaq', data_type='trades')
 ws.run(on_message=lambda message: print(message))
+ws.subscribe(['AMZN', 'GOOG', 'TSLA'])
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
@@ -140,39 +135,33 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-### WebSocket Books (without spawning a new thread for incoming server messages)
+##### Trades, BMV (MX)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='books', instruments=['PETR4', 'VALE3'])
-ws.run(on_message=lambda message: print(message), spawn_thread=False)
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', exchange='bmv', data_type='trades')
+ws.run(on_message=lambda message: print(message))
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
-
-## Another examples
-# ws.available_to_subscribe()
 ```
 
-### WebSocket Books with n = 1 (Book TOB - Top Of Book) 
+##### Security List
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='books')
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='securities', data_subtype='derivatives')
 ws.run(on_message=lambda message: print(message))
-ws.subscribe(['PETR4', 'VALE3'], n=1)
+
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
-
-## Another examples
-# ws.available_to_subscribe()
 ```
 
-### WebSocket Instrument Status
+##### Security Status
 
 ```python
 import btgsolutions_dataservices as btg
@@ -180,18 +169,20 @@ ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='books')
 ws.run(on_message=lambda message: print(message))
 ws.instrument_status('PETR4')
 ws.instrument_status_history('PETR4')
+
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
 #   sleep(1)
 ```
 
-### WebSocket High Frequency News
+##### Candles (1 second candles)
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.HFNWebSocketClient(api_key='YOUR_API_KEY', country='brazil')
+ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='candles-1S', stream_type='realtime')
 ws.run(on_message=lambda message: print(message))
+ws.candle_subscribe(list_instruments=['PETR4','VALE3'], candle_type='partial')
 
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
@@ -199,7 +190,7 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-### IntradayCandles
+#### Intraday Candles
 
 ```python
 import btgsolutions_dataservices as btg
@@ -207,47 +198,69 @@ int_candles = btg.IntradayCandles(api_key='YOUR_API_KEY')
 int_candles.get_intraday_candles(market_type='stocks', tickers=['PETR4', 'VALE3'], candle_period='1m', delay='delayed', mode='relative', timezone='UTC', raw_data=True)
 ```
 
-### Get Interday History Candles
+#### Intraday Tick Data
 
 ```python
 import btgsolutions_dataservices as btg
-hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
-hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False)
+intra_tickdata = btg.IntradayTickData(api_key='YOUR_API_KEY')
+intra_tickdata.get_trades(ticker='PETR4')
+```
+
+#### Quotes
+
+```python
+import btgsolutions_dataservices as btg
+quotes = btg.Quotes(api_key='YOUR_API_KEY')
+quotes.get_quote(market_type = 'stocks', tickers = ['PETR4', 'VALE3'])
 ```
 
-### Get Intraday History Candles
+#### Ticker Last Event
+
+```python
+import btgsolutions_dataservices as btg
+last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
+last_event.get_trades(data_type='equities', ticker='VALE3')
+```
+
+### Historical Data
+
+#### Historical Candles
+
+##### Interday
 
 ```python
 import btgsolutions_dataservices as btg
 hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
-hist_candles.get_intraday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, date='2023-10-06', candle='1m', rmv_after_market=True, timezone='UTC', raw_data=False)
+hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False)
 ```
 
-### Plot History Candles
+##### Intraday
 
 ```python
 import btgsolutions_dataservices as btg
 hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
-hist_candles.get_intraday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, date='2023-10-06', candle='1m', rmv_after_market=True, timezone='UTC', raw_data=False).plot(x='candle_time', y='close_price', kind='scatter')
+hist_candles.get_intraday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, date='2023-10-06', candle='1m', rmv_after_market=True, timezone='UTC', raw_data=False)
 ```
 
-### Quotes
+##### Available Tickers
 
 ```python
 import btgsolutions_dataservices as btg
-quotes = btg.Quotes(api_key='YOUR_API_KEY')
-quotes.get_quote(market_type = 'stocks', tickers = ['PETR4', 'VALE3'])
+hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
+hist_candles.get_available_tickers(market_type='stocks', date='2025-05-29')
 ```
 
-### Ticker Last Event
+##### Plot Candles
 
 ```python
 import btgsolutions_dataservices as btg
-last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
-last_event.get_trades(data_type='equities', ticker='VALE3')
+hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
+hist_candles.get_intraday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, date='2023-10-06', candle='1m', rmv_after_market=True, timezone='UTC', raw_data=False).plot(x='candle_time', y='close_price', kind='scatter')
 ```
 
-### BulkData - Available Tickers
+#### Historical Tick Data (Bulk Data)
+
+##### Available Tickers
 
 ```python
 import btgsolutions_dataservices as btg
@@ -255,7 +268,7 @@ bulk_data = btg.BulkData(api_key='YOUR_API_KEY')
 bulk_data.get_available_tickers(date='2023-07-03', data_type='trades', prefix='PETR')
 ```
 
-### BulkData - Get Data
+##### Get Data
 
 ```python
 import btgsolutions_dataservices as btg
@@ -266,15 +279,15 @@ bulk_data.get_data(ticker='DI1F18', date='2017-01-02', data_type='trades')
 # bulk_data.get_data(ticker='PETR4', date='2025-05-07', data_type='instrument-status')
 ```
 
-### BulkData - Get Security List
+##### Security List
 
 ```python
 import btgsolutions_dataservices as btg
 bulk_data = btg.BulkData(api_key='YOUR_API_KEY')
-bulk_data.security-list(date='2025-05-07')
+bulk_data.get_security_list(date='2025-05-07')
 ```
 
-### BulkData - Get Market Data Channels
+##### Market Data Channels
 
 ```python
 import btgsolutions_dataservices as btg
@@ -282,7 +295,7 @@ bulk_data = btg.BulkData(api_key='YOUR_API_KEY')
 bulk_data.get_market_data_channels(date='2024-01-03')
 ```
 
-### BulkData - Get Compressed Data (PCAP files)
+##### Compressed Data (PCAP files)
 
 ```python
 import btgsolutions_dataservices as btg
@@ -292,15 +305,22 @@ bulk_data.get_compressed_data(channel='001', date='2024-01-03', data_type='instr
 # bulk_data.get_compressed_data(channel='051', date='2024-01-03', data_type='snapshot')
 ```
 
-### Intraday Tick Data
+### Alternative Data
+
+#### High Frequency News Stream
 
 ```python
 import btgsolutions_dataservices as btg
-intra_tickdata = btg.IntradayTickData(api_key='YOUR_API_KEY')
-intra_tickdata.get_trades(ticker='PETR4')
+ws = btg.HFNWebSocketClient(api_key='YOUR_API_KEY', country='brazil')
+ws.run(on_message=lambda message: print(message))
+
+## The following is optional to keep the program running in a .py file:
+# from time import sleep
+# while True:
+#   sleep(1)
 ```
 
-### High Frequency News
+#### High Frequency News
 
 ```python
 import btgsolutions_dataservices as btg
@@ -308,17 +328,17 @@ hfn = btg.HighFrequencyNews(api_key='YOUR_API_KEY')
 hfn.latest_news()
 ```
 
-### Corporate Events
+#### OPA
 
 ```python
 import btgsolutions_dataservices as btg
-corporate_events = btg.CorporateEvents(api_key='YOUR_API_KEY')
-corporate_events.get(start_date='2024-05-01', end_date='2024-05-31')
-# corporate_events.get(start_date='2024-05-01', end_date='2024-05-31', tickers=['VALE3'])
+public_sources = btg.PublicSources(api_key='YOUR_API_KEY')
+public_sources.get_opas(start_date='2022-10-01', end_date='2024-10-01')
 ```
 
-### Company Data
-#### Company General Information
+#### Company Fundamentals
+
+##### Company General Information
 
 ```python
 import btgsolutions_dataservices as btg
@@ -326,7 +346,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.general_info(ticker='PETR4')
 ```
 
-#### Income Statement
+##### Income Statement
 
 ```python
 import btgsolutions_dataservices as btg
@@ -334,7 +354,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.income_statement(ticker='PETR4')
 ```
 
-#### Balance Sheet
+##### Balance Sheet
 
 ```python
 import btgsolutions_dataservices as btg
@@ -342,7 +362,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.balance_sheet(ticker='PETR4')
 ```
 
-#### Cash Flow
+##### Cash Flow
 
 ```python
 import btgsolutions_dataservices as btg
@@ -350,7 +370,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.cash_flow(ticker='PETR4')
 ```
 
-#### Valuation
+##### Valuation
 
 ```python
 import btgsolutions_dataservices as btg
@@ -358,7 +378,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.valuation(ticker='PETR4')
 ```
 
-#### Ratios
+##### Ratios
 
 ```python
 import btgsolutions_dataservices as btg
@@ -366,7 +386,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.ratios(ticker='PETR4')
 ```
 
-#### Growth
+##### Growth
 
 ```python
 import btgsolutions_dataservices as btg
@@ -374,7 +394,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.growth(ticker='PETR4')
 ```
 
-#### Interims
+##### Interims
 
 ```python
 import btgsolutions_dataservices as btg
@@ -382,7 +402,7 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.interims(ticker='PETR4')
 ```
 
-#### All Financial Tables
+##### All Financial Tables
 
 ```python
 import btgsolutions_dataservices as btg
@@ -390,22 +410,21 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.all_financial_tables(ticker='PETR4')
 ```
 
-### Public Sources - OPA
+### Reference Data
+
+#### Corporate Events
 
 ```python
 import btgsolutions_dataservices as btg
-public_sources = btg.PublicSources(api_key='YOUR_API_KEY')
-public_sources.get_opas(start_date='2022-10-01', end_date='2024-10-01')
+corporate_events = btg.CorporateEvents(api_key='YOUR_API_KEY')
+corporate_events.get(start_date='2024-05-01', end_date='2024-05-31')
+# corporate_events.get(start_date='2024-05-01', end_date='2024-05-31', tickers=['VALE3'])
 ```
 
-### Reference Data - Ticker Reference
+#### Ticker Reference Data
 
 ```python
 import btgsolutions_dataservices as btg
 ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
-
-## Documentation
-
-The official documentation is hosted at https://python-client-docs.dataservices.btgpactualsolutions.com/

{btgsolutions_dataservices_python_client-2.10.1.dist-info → btgsolutions_dataservices_python_client-2.11.4.dist-info}/RECORD

@@ -1,5 +1,5 @@
 btgsolutions_dataservices/__init__.py,sha256=reSSb9MBIp5WQ5o872fX__moJYXx0sQgkhUf3QmfEjI,93
-btgsolutions_dataservices/config.py,sha256=bwlApl8JtuKRP4J9rbQERo1Cuk32n1MBaqYBHeSKhFc,5024
+btgsolutions_dataservices/config.py,sha256=syf7x6LL4WNAM0e6CI1BKfPHnprxWoww7llzvtV0QXs,5082
 btgsolutions_dataservices/exceptions.py,sha256=QlwQTDEohtVsTER0lHbQrDgAGvjiZBmoyDuqLkUcvh8,599
 btgsolutions_dataservices/rest/__init__.py,sha256=OI7KWRdAMG3oHABhaGn6nOsGCou4-FX7e0qH2rxChmE,494
 btgsolutions_dataservices/rest/authenticator.py,sha256=uBLARz5lCRhIDc_PZaC4a2rSQtrFJajmAC4Bdg9BnX0,1363
@@ -7,19 +7,20 @@ btgsolutions_dataservices/rest/bulk_data.py,sha256=26CrFH-IVMUbpPLx0HaN-BePs5R9A
 btgsolutions_dataservices/rest/company_data.py,sha256=yhsgR-P7g5e6TDdpoMZoyiyqI85roBCXJGyob4g1P_8,7318
 btgsolutions_dataservices/rest/corporate_events.py,sha256=04DdoUnBaX1rSAWplCLzNm-YPrKks80txOR26xubEZ0,2399
 btgsolutions_dataservices/rest/hfn.py,sha256=0E-oNw797M8XgbDfwbhmMaPaf9z-WN4rhMpMR_2dkos,11205
-btgsolutions_dataservices/rest/historical_candles.py,sha256=RYLLXaFMEe1yx4iaQJVSoV2T2xUEo1eIL8KuTR07MqY,6203
+btgsolutions_dataservices/rest/historical_candles.py,sha256=0iu3clwbJUtwyHotxT5pb3xsqCJvpd6kRUsrYBVNU80,7359
 btgsolutions_dataservices/rest/intraday_candles.py,sha256=scH2eMh3ZhtWii_Kzv3PEGcUaLAUT-CAeswCY-3pYVc,5221
 btgsolutions_dataservices/rest/intraday_tick_data.py,sha256=VZZ-yPoQn9dZCJ9KnPYGwaEFq2FZi0oSnLDIIENYCNo,2469
 btgsolutions_dataservices/rest/public_sources.py,sha256=CMXsvHe8RKuEmJJ_baeVgsj28TrH2AYxE3TEfGSCdOQ,2459
 btgsolutions_dataservices/rest/quotes.py,sha256=sirlG1-_aCtE7auwYM7lTZkpMcW3UYisjtCaBWzPWuY,7508
 btgsolutions_dataservices/rest/reference_data.py,sha256=ntcHEMapKULGPHJvmzAnccUo8ZTGokt1M9bDBceV5Tk,2112
 btgsolutions_dataservices/rest/ticker_last_event.py,sha256=Lnm8sGS6wo6frL8yJddtBtEOEsPiodgjl4qq5Xdo0P0,2950
-btgsolutions_dataservices/websocket/__init__.py,sha256=pD5Rj9wV8UX5t5FQPp4BmqwtxTedshPPdYjduUGfrbU,120
+btgsolutions_dataservices/websocket/__init__.py,sha256=Bifok6zQFenYNIA-NE8hYSooZVIQ2MCeTCjIOYnfHzI,165
 btgsolutions_dataservices/websocket/hfn_websocket_client.py,sha256=wzyPXtXFsv31cVFcTWrTA5uhFBebgM2IpIxXQvPSP54,6253
-btgsolutions_dataservices/websocket/market_data_websocket_client.py,sha256=kAavzTQUd1Ki838JRFwfbDsbEaIehRGJlx-eurVx0Lw,13353
-btgsolutions_dataservices/websocket/websocket_default_functions.py,sha256=OvqJoyIt2vopwL1z4Mj3EkkpnPsYrdWHux4825WCDsk,270
-btgsolutions_dataservices_python_client-2.10.1.dist-info/licenses/LICENSE,sha256=vePSp4Jry-f15vZ48xge2vljuhNgkMZD6wU0XmuFBgA,1057
-btgsolutions_dataservices_python_client-2.10.1.dist-info/METADATA,sha256=a0FB3b1aRRaqgNkPSXBOeSLMSlId2ZExwULzR63VAhI,11774
-btgsolutions_dataservices_python_client-2.10.1.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-btgsolutions_dataservices_python_client-2.10.1.dist-info/top_level.txt,sha256=OaseSN41lI9j_Z-kHIE_XVo_m1hmGdAHE3EK1h5_Ce0,26
-btgsolutions_dataservices_python_client-2.10.1.dist-info/RECORD,,
+btgsolutions_dataservices/websocket/market_data_feed.py,sha256=Zh3aqFLoVZPnA3LVXCRxcsPYdlQId9qifrQsBkWUWrg,11770
+btgsolutions_dataservices/websocket/market_data_websocket_client.py,sha256=i_1kd6mdd9fLDYD54zx_t1HJPPBUdDzE4pojs3DIPLI,13375
+btgsolutions_dataservices/websocket/websocket_default_functions.py,sha256=JWbOR4uX14BI9JB3zXMbwqVsF8AtfDbEC83fgs8O5PY,335
+btgsolutions_dataservices_python_client-2.11.4.dist-info/licenses/LICENSE,sha256=vePSp4Jry-f15vZ48xge2vljuhNgkMZD6wU0XmuFBgA,1057
+btgsolutions_dataservices_python_client-2.11.4.dist-info/METADATA,sha256=___fOIFhAUcvenXmiN89UeDuljLwG8JBwtmNoBq5hMc,11808
+btgsolutions_dataservices_python_client-2.11.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+btgsolutions_dataservices_python_client-2.11.4.dist-info/top_level.txt,sha256=OaseSN41lI9j_Z-kHIE_XVo_m1hmGdAHE3EK1h5_Ce0,26
+btgsolutions_dataservices_python_client-2.11.4.dist-info/RECORD,,

{btgsolutions_dataservices_python_client-2.10.1.dist-info → btgsolutions_dataservices_python_client-2.11.4.dist-info}/WHEEL

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