btgsolutions-dataservices-python-client 3.2.5__tar.gz → 3.2.7__tar.gz

{btgsolutions_dataservices_python_client-3.2.5/btgsolutions_dataservices_python_client.egg-info → btgsolutions_dataservices_python_client-3.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: btgsolutions_dataservices_python_client
-Version: 3.2.5
+Version: 3.2.7
 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
@@ -445,6 +445,14 @@ 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'])
 ```
 
+#### Broker Reference
+
+```python
+import btgsolutions_dataservices as btg
+broker_reference = btg.BrokerReference(api_key='YOUR_API_KEY')
+broker_reference.get()
+```
+
 #### Ticker Reference Data
 
 ```python

{btgsolutions_dataservices_python_client-3.2.5 → btgsolutions_dataservices_python_client-3.2.7}/README.md

@@ -422,6 +422,14 @@ 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'])
 ```
 
+#### Broker Reference
+
+```python
+import btgsolutions_dataservices as btg
+broker_reference = btg.BrokerReference(api_key='YOUR_API_KEY')
+broker_reference.get()
+```
+
 #### Ticker Reference Data
 
 ```python

{btgsolutions_dataservices_python_client-3.2.5 → btgsolutions_dataservices_python_client-3.2.7}/btgsolutions_dataservices/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.2.5" 
+__version__ = "3.2.7" 
 
 from .websocket import *
 from .rest import *

{btgsolutions_dataservices_python_client-3.2.5 → btgsolutions_dataservices_python_client-3.2.7}/btgsolutions_dataservices/rest/__init__.py

@@ -12,3 +12,4 @@ from .public_sources import PublicSources
 from .reference_data import ReferenceData
 from .stock_loan import StockLoan
 from .ticker_last_event_polling import TickerLastEventPolling
+from .broker_reference import BrokerReference

btgsolutions_dataservices_python_client-3.2.7/btgsolutions_dataservices/rest/broker_reference.py

@@ -0,0 +1,63 @@
+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 BrokerReference:
+    """
+    This class provides broker reference information.
+
+    * Main use case:
+
+    >>> from btgsolutions_dataservices import BrokerReference
+    >>> broker_reference = BrokerReference(
+    >>>     api_key='YOUR_API_KEY',
+    >>> )
+    >>> broker_reference.get()
+
+    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}"}
+
+    def get(self, raw_data:bool=False): 
+
+        """
+        Returns the full broker reference dataset from the API.
+
+        Parameters
+        ----------------
+        raw_data: bool
+            If False, returns the response as a pandas DataFrame.
+            If True, returns the raw JSON payload.
+            Field is not required. Default: False.
+
+        Returns
+        ----------------
+        pandas.DataFrame | dict | list
+            Broker reference data returned by the API.
+        """
+
+        url = f"{url_api_v1}/marketdata/broker/info/all-brokers"
+
+        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", "")}')

{btgsolutions_dataservices_python_client-3.2.5 → btgsolutions_dataservices_python_client-3.2.7/btgsolutions_dataservices_python_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: btgsolutions_dataservices_python_client
-Version: 3.2.5
+Version: 3.2.7
 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
@@ -445,6 +445,14 @@ 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'])
 ```
 
+#### Broker Reference
+
+```python
+import btgsolutions_dataservices as btg
+broker_reference = btg.BrokerReference(api_key='YOUR_API_KEY')
+broker_reference.get()
+```
+
 #### Ticker Reference Data
 
 ```python

{btgsolutions_dataservices_python_client-3.2.5 → btgsolutions_dataservices_python_client-3.2.7}/btgsolutions_dataservices_python_client.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ btgsolutions_dataservices/config.py
 btgsolutions_dataservices/exceptions.py
 btgsolutions_dataservices/rest/__init__.py
 btgsolutions_dataservices/rest/authenticator.py
+btgsolutions_dataservices/rest/broker_reference.py
 btgsolutions_dataservices/rest/bulk_data.py
 btgsolutions_dataservices/rest/company_data.py
 btgsolutions_dataservices/rest/corporate_events.py