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

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

@@ -1,25 +1,14 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: btgsolutions-dataservices-python-client
-Version: 2.11.8
+Version: 2.12.0
 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
 
@@ -214,7 +203,7 @@ quotes = btg.Quotes(api_key='YOUR_API_KEY')
 quotes.get_quote(market_type = 'stocks', tickers = ['PETR4', 'VALE3'])
 ```
 
-#### Ticker Last Event
+#### Ticker Last Event (Trades)
 
 ```python
 import btgsolutions_dataservices as btg
@@ -222,6 +211,14 @@ last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
 last_event.get_trades(data_type='equities', ticker='VALE3')
 ```
 
+#### Ticker Last Event (TOBs)
+
+```python
+import btgsolutions_dataservices as btg
+last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
+last_event.get_tobs(data_type='stocks')
+```
+
 ### Historical Data
 
 #### Historical Candles
@@ -428,3 +425,5 @@ import btgsolutions_dataservices as btg
 ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
+
+

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

@@ -191,7 +191,7 @@ quotes = btg.Quotes(api_key='YOUR_API_KEY')
 quotes.get_quote(market_type = 'stocks', tickers = ['PETR4', 'VALE3'])
 ```
 
-#### Ticker Last Event
+#### Ticker Last Event (Trades)
 
 ```python
 import btgsolutions_dataservices as btg
@@ -199,6 +199,14 @@ last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
 last_event.get_trades(data_type='equities', ticker='VALE3')
 ```
 
+#### Ticker Last Event (TOBs)
+
+```python
+import btgsolutions_dataservices as btg
+last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
+last_event.get_tobs(data_type='stocks')
+```
+
 ### Historical Data
 
 #### Historical Candles

btgsolutions-dataservices-python-client-2.12.0/btgsolutions_dataservices/rest/ticker_last_event.py

@@ -0,0 +1,147 @@
+from typing import Optional
+from ..exceptions import BadResponse
+import requests
+from ..config import url_api_v1
+from .authenticator import Authenticator
+import pandas as pd
+import json
+
+class TickerLastEvent:
+    """
+    This class provides the last market data event available, for the provided ticker
+
+    * Main use case:
+
+    >>> from btgsolutions_dataservices import TickerLastEvent
+    >>> last_event = TickerLastEvent(
+    >>>     api_key='YOUR_API_KEY',
+    >>> )
+
+    >>> last_event.get_trades(
+    >>>     data_type = 'equities',
+    >>>     ticker = 'PETR4',
+    >>>     raw_data = False
+    >>> )
+
+    >>> last_event.get_tob(
+    >>>     data_type = 'stocks',
+    >>>     raw_data = False
+    >>> )
+
+    Parameters
+    ----------------
+    api_key: str
+        User identification key.
+        Field is required.
+    """
+    def __init__(
+        self,
+        api_key:Optional[str]
+    ):
+        self.api_key = api_key
+        self.authenticator = Authenticator(self.api_key)
+
+        self.available_data_types = {
+            "trades": ['equities', 'derivatives'],
+            "books": ['stocks', 'derivatives', 'options']
+        }
+
+    def get_trades(self, data_type:str, ticker:str, raw_data:bool=False):
+
+        """
+        This method provides the last market data event available, for the provided ticker.
+
+        Parameters
+        ----------------
+        data_type: str
+            Market Data Type.
+            Field is required. 
+            Example: 'equities', 'derivatives'.
+        ticker: str
+            Ticker symbol.
+            Field is required. Example: 'PETR4'.
+        raw_data: bool
+            If false, returns data in a dataframe. If true, returns raw data.
+            Field is not required. Default: False.
+        """
+        if data_type not in self.available_data_types["trades"]:
+            raise Exception(f"Must provide a valid data_type. Valid data types are: {self.available_data_types['trades']}")
+
+        url = f"{url_api_v1}/marketdata/last-event/trades/{data_type}?ticker={ticker}"
+
+        response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
+        if response.status_code == 200:
+            if raw_data:
+                return response.json()
+            else:
+                return pd.DataFrame([response.json()])
+        else:
+            response = json.loads(response.text)
+            raise BadResponse(f'Error: {response.get("error", "")}')
+        
+    def get_tobs(self, data_type:str, raw_data:bool=False):
+
+        """
+        This method gives the last available book type for all tickers of the given type.
+
+        Parameters
+        ----------------
+        data_type: str
+            Market Data Type.
+            Field is required. 
+            Example: 'stocks', 'derivatives', 'options'.
+        raw_data: bool
+            If false, returns data in a dataframe. If true, returns raw data.
+            Field is not required. Default: False.
+        """
+
+        if data_type not in self.available_data_types["books"]:
+            raise Exception(f"Must provide a valid data_type. Valid data types are: {self.available_data_types}")
+
+        url = f"{url_api_v1}/marketdata/last-event/books/top/{data_type}/batch"
+
+        response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
+
+        if response.status_code == 200:
+            if raw_data:
+                return response.json()
+            else:
+                return pd.DataFrame(response.json())
+        else:
+
+            response = json.loads(response.text)
+            raise BadResponse(f'Error: {response.get("error", "")}')
+
+
+    def get_available_tickers(self,type:str, data_type:str):
+
+        """
+        This method provides all the available tickers for the specific data type.
+
+        Parameters
+        ----------------
+        type: str
+            Data Type.
+            Field is required. 
+            Example: 'trades', 'books'
+        data_type: str
+            Market Data Type.
+            Field is required. 
+            Example: 'equities', 'derivatives', 'options', 'stocks'.
+        """
+
+        if type not in self.available_data_types:
+            raise Exception(f"Must provide a valid type. Valid data types are: {list(self.available_data_types.keys())}")
+        
+        if data_type not in self.available_data_types[type]:
+            raise Exception(f"Must provide a valid data_type. Valid data types are: {self.available_data_types['books']}")
+
+        url = f"{url_api_v1}/marketdata/last-event/trades/{data_type}/available-tickers" if type == "trades" else \
+            f"{url_api_v1}/marketdata/last-event/books/{data_type}/availables"
+
+        response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
+        if response.status_code == 200:
+            return response.json()
+        else:
+            response = json.loads(response.text)
+            raise BadResponse(f'Error: {response.get("error", "")}')

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

@@ -1,25 +1,14 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: btgsolutions-dataservices-python-client
-Version: 2.11.8
+Version: 2.12.0
 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
 
@@ -214,7 +203,7 @@ quotes = btg.Quotes(api_key='YOUR_API_KEY')
 quotes.get_quote(market_type = 'stocks', tickers = ['PETR4', 'VALE3'])
 ```
 
-#### Ticker Last Event
+#### Ticker Last Event (Trades)
 
 ```python
 import btgsolutions_dataservices as btg
@@ -222,6 +211,14 @@ last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
 last_event.get_trades(data_type='equities', ticker='VALE3')
 ```
 
+#### Ticker Last Event (TOBs)
+
+```python
+import btgsolutions_dataservices as btg
+last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
+last_event.get_tobs(data_type='stocks')
+```
+
 ### Historical Data
 
 #### Historical Candles
@@ -428,3 +425,5 @@ import btgsolutions_dataservices as btg
 ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
+
+

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

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

btgsolutions_dataservices_python_client-2.11.8/btgsolutions_dataservices/rest/ticker_last_event.py

@@ -1,94 +0,0 @@
-from typing import Optional
-from ..exceptions import BadResponse
-import requests
-from ..config import url_api_v1
-from .authenticator import Authenticator
-import pandas as pd
-import json
-
-class TickerLastEvent:
-    """
-    This class provides the last market data event available, for the provided ticker
-
-    * Main use case:
-
-    >>> from btgsolutions_dataservices import TickerLastEvent
-    >>> last_event = TickerLastEvent(
-    >>>     api_key='YOUR_API_KEY',
-    >>> )
-
-    >>> last_event.get_trades(
-    >>>     ticker = 'PETR4',
-    >>>     raw_data = False
-    >>> )
-
-    Parameters
-    ----------------
-    api_key: str
-        User identification key.
-        Field is required.
-    """
-    def __init__(
-        self,
-        api_key:Optional[str]
-    ):
-        self.api_key = api_key
-        self.token = Authenticator(self.api_key).token
-        self.headers = {"authorization": f"authorization {self.token}"}
-
-        self.available_data_types = ['equities', 'derivatives']
-
-    def get_trades(self, data_type:str, ticker:str, raw_data:bool=False):
-
-        """
-        This method provides the last market data event available, for the provided ticker.
-
-        Parameters
-        ----------------
-        data_type: str
-            Market Data Type.
-            Field is required. 
-            Example: 'equities', 'derivatives'.
-        ticker: str
-            Ticker symbol.
-            Field is required. Example: 'PETR4'.
-        raw_data: bool
-            If false, returns data in a dataframe. If true, returns raw data.
-            Field is not required. Default: False.
-        """
-        if data_type not in self.available_data_types:
-            raise Exception("Must provide a valid data_type. Valid data types are: {self.available_data_types}")
-
-        url = f"{url_api_v1}/marketdata/last-event/trades/{data_type}?ticker={ticker}"
-
-        response = requests.request("GET", url,  headers=self.headers)
-        if response.status_code == 200:
-            if raw_data:
-                return response.json()
-            else:
-                return pd.DataFrame([response.json()])
-        else:
-            response = json.loads(response.text)
-            raise BadResponse(f'Error: {response.get("error", "")}')
-
-    def get_available_tickers(self, data_type:str):
-
-        """
-        This method provides all the available tickers for the specific data type.
-
-        Parameters
-        ----------------
-        data_type: str
-            Market Data Type.
-            Field is required. 
-            Example: 'equities', 'derivatives'.
-        """
-
-        url = f"{url_api_v1}/marketdata/last-event/trades/{data_type}/available-tickers"
-
-        response = requests.request("GET", url,  headers=self.headers)
-        if response.status_code == 200:
-            return response.json()
-        else:
-            response = json.loads(response.text)
-            raise BadResponse(f'Error: {response.get("error", "")}')

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

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