btgsolutions-dataservices-python-client 2.11.3__tar.gz → 2.11.4__tar.gz

{btgsolutions_dataservices_python_client-2.11.3/btgsolutions_dataservices_python_client.egg-info → btgsolutions_dataservices_python_client-2.11.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: btgsolutions-dataservices-python-client
-Version: 2.11.3
+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
@@ -242,6 +242,14 @@ 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)
 ```
 
+##### Available Tickers
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
+hist_candles.get_available_tickers(market_type='stocks', date='2025-05-29')
+```
+
 ##### Plot Candles
 
 ```python

{btgsolutions_dataservices_python_client-2.11.3 → btgsolutions_dataservices_python_client-2.11.4}/README.md

@@ -219,6 +219,14 @@ 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)
 ```
 
+##### Available Tickers
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
+hist_candles.get_available_tickers(market_type='stocks', date='2025-05-29')
+```
+
 ##### Plot Candles
 
 ```python

{btgsolutions_dataservices_python_client-2.11.3 → btgsolutions_dataservices_python_client-2.11.4}/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_python_client-2.11.3 → btgsolutions_dataservices_python_client-2.11.4/btgsolutions_dataservices_python_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: btgsolutions-dataservices-python-client
-Version: 2.11.3
+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
@@ -242,6 +242,14 @@ 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)
 ```
 
+##### Available Tickers
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
+hist_candles.get_available_tickers(market_type='stocks', date='2025-05-29')
+```
+
 ##### Plot Candles
 
 ```python

{btgsolutions_dataservices_python_client-2.11.3 → btgsolutions_dataservices_python_client-2.11.4}/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.3',
+    version='2.11.4',
     description=description,
     long_description=long_description,
     long_description_content_type='text/markdown',