btgsolutions-dataservices-python-client 2.12.0__tar.gz → 2.13.1__tar.gz

{btgsolutions-dataservices-python-client-2.12.0/btgsolutions_dataservices_python_client.egg-info → btgsolutions_dataservices_python_client-2.13.1}/PKG-INFO

@@ -1,14 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: btgsolutions-dataservices-python-client
-Version: 2.12.0
+Version: 2.13.1
 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
-License: UNKNOWN
-Platform: UNKNOWN
 Requires-Python: >=3.9,<3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: websocket-client>=1.8.0
+Requires-Dist: PyJWT>=2.8.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pyarrow>=17.0.0
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # BTG Solutions - Data Services
 
@@ -154,7 +165,7 @@ ws.run(on_message=lambda message: print(message))
 
 ```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='instrument_status', data_subtype='stocks')
 ws.run(on_message=lambda message: print(message))
 ws.instrument_status('PETR4')
 ws.instrument_status_history('PETR4')
@@ -425,5 +436,3 @@ import btgsolutions_dataservices as btg
 ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
-
-

{btgsolutions-dataservices-python-client-2.12.0 → btgsolutions_dataservices_python_client-2.13.1}/README.md

@@ -142,7 +142,7 @@ ws.run(on_message=lambda message: print(message))
 
 ```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='instrument_status', data_subtype='stocks')
 ws.run(on_message=lambda message: print(message))
 ws.instrument_status('PETR4')
 ws.instrument_status_history('PETR4')

{btgsolutions-dataservices-python-client-2.12.0 → btgsolutions_dataservices_python_client-2.13.1}/btgsolutions_dataservices/websocket/market_data_feed.py

@@ -351,7 +351,7 @@ class MarketDataFeed:
             message = json.dumps(message)
         self.client_message_queue.put(json.loads(message))
 
-    def subscribe(self, list_instruments: List[str], n=None):
+    def subscribe(self, list_instruments: List[str], n=None, initial_snapshot: bool=False):
         """
         Subscribes a list of instruments.
 
@@ -363,9 +363,17 @@ class MarketDataFeed:
             Field is not required.
             **For books data_type only.**
             Maximum book level. It must be between 1 and 10.    
+        initial_snapshot: float
+            If True, client receives ticker last event (snapshot) of the provided ticker. 
+            Field is not required.
+            Default: False
         """
-        if self.data_type == BOOKS and n is not None:
-            self._send({'action': 'subscribe', 'params': {"tickers": list_instruments, "n": n}})
+
+        if initial_snapshot or n is not None:
+            message = {'action': 'subscribe', 'params': {"tickers": list_instruments, "initial_snapshot": initial_snapshot}}
+            if n is not None:
+                message['params']['n'] = n
+            self._send(message)
         else:
             self._send({'action': 'subscribe', 'params': list_instruments})
 

{btgsolutions-dataservices-python-client-2.12.0 → btgsolutions_dataservices_python_client-2.13.1}/btgsolutions_dataservices/websocket/market_data_websocket_client.py

@@ -267,7 +267,7 @@ class MarketDataWebSocketClient:
         """
         self.ws.close()
 
-    def subscribe(self, list_instruments, n=None):
+    def subscribe(self, list_instruments, n=None, initial_snapshot: bool=False):
         """
         Subscribes a list of instruments.
 
@@ -278,12 +278,19 @@ class MarketDataWebSocketClient:
         n: int
             Field is not required.
             **For books data_type only.**
-            Maximum book level. It must be between 1 and 10.    
+            Maximum book level. It must be between 1 and 10. 
+        initial_snapshot: float
+            If True, client receives ticker last event (snapshot) of the provided ticker. 
+            Field is not required.
+            Default: False
         """
 
-        if self.data_type == BOOKS and n is not None:
-            self.__send({'action': 'subscribe', 'params': {"tickers": list_instruments, "n": n}})
-            self.__print(f'Socket subscribed the following instrument(s) with n = {n}: {list_instruments}')
+        if initial_snapshot or n is not None:
+            message = {'action': 'subscribe', 'params': {"tickers": list_instruments, "initial_snapshot": initial_snapshot}}
+            if n is not None:
+                message['params']['n'] = n
+            self.__send(message)
+            self.__print(f'Socket subscribed the following instrument(s) with n = {n}: {list_instruments} and initial_snapshot = {initial_snapshot}')
         else:
             self.__send({'action': 'subscribe', 'params': list_instruments})
             self.__print(f'Socket subscribed the following instrument(s): {list_instruments}')

{btgsolutions-dataservices-python-client-2.12.0 → btgsolutions_dataservices_python_client-2.13.1/btgsolutions_dataservices_python_client.egg-info}/PKG-INFO

@@ -1,14 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: btgsolutions-dataservices-python-client
-Version: 2.12.0
+Version: 2.13.1
 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
-License: UNKNOWN
-Platform: UNKNOWN
 Requires-Python: >=3.9,<3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: websocket-client>=1.8.0
+Requires-Dist: PyJWT>=2.8.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: pyarrow>=17.0.0
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # BTG Solutions - Data Services
 
@@ -154,7 +165,7 @@ ws.run(on_message=lambda message: print(message))
 
 ```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='instrument_status', data_subtype='stocks')
 ws.run(on_message=lambda message: print(message))
 ws.instrument_status('PETR4')
 ws.instrument_status_history('PETR4')
@@ -425,5 +436,3 @@ import btgsolutions_dataservices as btg
 ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
-
-

{btgsolutions-dataservices-python-client-2.12.0 → btgsolutions_dataservices_python_client-2.13.1}/setup.py

@@ -22,7 +22,7 @@ description = "Python package containing several classes and data for extracting
 
 setup(
     name='btgsolutions-dataservices-python-client',
-    version='2.12.0',
+    version='2.13.1',
     description=description,
     long_description=long_description,
     long_description_content_type='text/markdown',

{btgsolutions-dataservices-python-client-2.12.0 → btgsolutions_dataservices_python_client-2.13.1}/btgsolutions_dataservices_python_client.egg-info/requires.txt

@@ -1,5 +1,5 @@
-PyJWT>=2.8.0
 pandas>=2.2.2
-pyarrow>=17.0.0
-requests>=2.32.3
 websocket-client>=1.8.0
+PyJWT>=2.8.0
+requests>=2.32.3
+pyarrow>=17.0.0