btgsolutions-dataservices-python-client 3.1.0__tar.gz → 3.2.1__tar.gz

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/PKG-INFO

@@ -1,14 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: btgsolutions_dataservices_python_client
-Version: 3.1.0
+Version: 3.2.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.14
 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
 
@@ -98,11 +109,11 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Trades, throttle (1 second throttle)
+##### Books, throttle (1 second throttle)
 
 ```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', stream_type='throttle', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
 
 ## The following is optional to keep the program running in a .py file:
@@ -138,19 +149,6 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Security List
-
-```python
-import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='securities', data_subtype='derivatives')
-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)
-```
-
 ##### Security Status
 
 ```python
@@ -181,20 +179,6 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Candles (1 second candles)
-
-```python
-import btgsolutions_dataservices as btg
-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
-# while True:
-#   sleep(1)
-```
-
 #### Intraday Candles
 
 ```python
@@ -232,7 +216,7 @@ last_event.get_trades(data_type='equities', ticker='VALE3')
 ```python
 import btgsolutions_dataservices as btg
 last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
-last_event.get_tobs(data_type='stocks')
+last_event.get_tobs(data_type='equities')
 ```
 
 #### Ticker Last Trading Status
@@ -469,5 +453,3 @@ ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
 
-
-

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/README.md

@@ -86,11 +86,11 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Trades, throttle (1 second throttle)
+##### Books, throttle (1 second throttle)
 
 ```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', stream_type='throttle', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
 
 ## The following is optional to keep the program running in a .py file:
@@ -126,19 +126,6 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Security List
-
-```python
-import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='securities', data_subtype='derivatives')
-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)
-```
-
 ##### Security Status
 
 ```python
@@ -169,20 +156,6 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Candles (1 second candles)
-
-```python
-import btgsolutions_dataservices as btg
-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
-# while True:
-#   sleep(1)
-```
-
 #### Intraday Candles
 
 ```python
@@ -220,7 +193,7 @@ last_event.get_trades(data_type='equities', ticker='VALE3')
 ```python
 import btgsolutions_dataservices as btg
 last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
-last_event.get_tobs(data_type='stocks')
+last_event.get_tobs(data_type='equities')
 ```
 
 #### Ticker Last Trading Status

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/btgsolutions_dataservices/config.py

@@ -1,4 +1,5 @@
 base_url = "https://dataservices.btgpactualsolutions.com"
+base_url_ws = "wss://dataservices.btgpactualsolutions.com"
 
 # WS
 url_ws = "wss://dataservices.btgpactualsolutions.com/stream/"
@@ -58,33 +59,33 @@ market_data_socket_urls = {
     B3: {
         TRADES: {
             REALTIME: {
-                STOCKS: f'{base_url}{ws_br_b3_base_path}trade/{STOCKS}',
-                OPTIONS: f'{base_url}{ws_br_b3_base_path}trade/{OPTIONS}',
-                DERIVATIVES: f'{base_url}{ws_br_b3_base_path}trade/{DERIVATIVES}',
+                STOCKS: f'{base_url_ws}{ws_br_b3_base_path}trade/{STOCKS}',
+                OPTIONS: f'{base_url_ws}{ws_br_b3_base_path}trade/{OPTIONS}',
+                DERIVATIVES: f'{base_url_ws}{ws_br_b3_base_path}trade/{DERIVATIVES}',
             },
             DELAYED: {
-                STOCKS: f'{base_url}{ws_br_b3_base_path}{DELAYED}/trade/{STOCKS}/{DELAYED}',
-                OPTIONS: f'{base_url}{ws_br_b3_base_path}{DELAYED}/trade/{OPTIONS}/{DELAYED}',
-                DERIVATIVES: f"{base_url}{ws_br_b3_base_path}{DELAYED}/trade/{DERIVATIVES}/{DELAYED}",
+                STOCKS: f'{base_url_ws}{ws_br_b3_base_path}{DELAYED}/trade/{STOCKS}/{DELAYED}',
+                OPTIONS: f'{base_url_ws}{ws_br_b3_base_path}{DELAYED}/trade/{OPTIONS}/{DELAYED}',
+                DERIVATIVES: f"{base_url_ws}{ws_br_b3_base_path}{DELAYED}/trade/{DERIVATIVES}/{DELAYED}",
             },
         },
         PROCESSEDTRADES: {
             REALTIME: {
-                STOCKS: f'{base_url}{ws_br_b3_base_path}{PROCESSED}-trade/{STOCKS}',
-                OPTIONS: f'{base_url}{ws_br_b3_base_path}{PROCESSED}-trade/{OPTIONS}',
-                DERIVATIVES: f'{base_url}{ws_br_b3_base_path}{PROCESSED}-trade/{DERIVATIVES}',
+                STOCKS: f'{base_url_ws}{ws_br_b3_base_path}{PROCESSED}-trade/{STOCKS}',
+                OPTIONS: f'{base_url_ws}{ws_br_b3_base_path}{PROCESSED}-trade/{OPTIONS}',
+                DERIVATIVES: f'{base_url_ws}{ws_br_b3_base_path}{PROCESSED}-trade/{DERIVATIVES}',
             },
         },
         BOOKS: {
             REALTIME: {
-                STOCKS: f'{base_url}{ws_br_b3_base_path}book-snapshot-mbp/{STOCKS}',
-                OPTIONS: f'{base_url}{ws_br_b3_base_path}book-snapshot-mbp/{OPTIONS}',
-                DERIVATIVES: f'{base_url}{ws_br_b3_base_path}book-snapshot-mbp/{DERIVATIVES}',
+                STOCKS: f'{base_url_ws}{ws_br_b3_base_path}book-snapshot-mbp/{STOCKS}',
+                OPTIONS: f'{base_url_ws}{ws_br_b3_base_path}book-snapshot-mbp/{OPTIONS}',
+                DERIVATIVES: f'{base_url_ws}{ws_br_b3_base_path}book-snapshot-mbp/{DERIVATIVES}',
             },
             THROTTLE: {
-                STOCKS: f"{base_url}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{STOCKS}",
-                OPTIONS: f"{base_url}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{OPTIONS}",
-                DERIVATIVES: f"{base_url}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{DERIVATIVES}",
+                STOCKS: f"{base_url_ws}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{STOCKS}",
+                OPTIONS: f"{base_url_ws}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{OPTIONS}",
+                DERIVATIVES: f"{base_url_ws}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{DERIVATIVES}",
             },
         },
         INDICES: {
@@ -97,14 +98,14 @@ market_data_socket_urls = {
         },
         INSTRUMENTSTATUS: {
             REALTIME: {
-                STOCKS: f"{base_url}{ws_br_b3_base_path}instrument-status/{STOCKS}",
-                DERIVATIVES: f"{base_url}{ws_br_b3_base_path}instrument-status/{DERIVATIVES}",
-                OPTIONS: f"{base_url}{ws_br_b3_base_path}instrument-status/{OPTIONS}",
+                STOCKS: f"{base_url_ws}{ws_br_b3_base_path}instrument-status/{STOCKS}",
+                DERIVATIVES: f"{base_url_ws}{ws_br_b3_base_path}instrument-status/{DERIVATIVES}",
+                OPTIONS: f"{base_url_ws}{ws_br_b3_base_path}instrument-status/{OPTIONS}",
             }
         },
         SETTLEMENTPRICES: {
             REALTIME: {
-                ALL: f"{base_url}{ws_br_b3_base_path}{SETTLEMENTPRICES}",
+                ALL: f"{base_url_ws}{ws_br_b3_base_path}{SETTLEMENTPRICES}/stocks",
             }
         }
     },

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/btgsolutions_dataservices/rest/intraday_candles.py

@@ -2,7 +2,7 @@
 from typing import Optional
 from ..exceptions import BadResponse, MarketTypeError, DelayError
 import requests
-from ..config import url_apis_v3
+from ..config import base_url
 import json
 import pandas as pd
 from .authenticator import Authenticator
@@ -111,7 +111,7 @@ class IntradayCandles:
 
         tickers = ','.join(tickers) if type(tickers) is list else tickers 
 
-        url = f"{url_apis_v3}/marketdata/candles/intraday/{delay}/{market_type}?tickers={tickers}&candle_period={candle_period}&mode={mode}&timezone={timezone}"
+        url = f"{base_url}/api/v1/marketdata/br/b3/{delay}/intraday-candles/{market_type}?tickers={tickers}&candle_period={candle_period}&mode={mode}&timezone={timezone}"
 
         if start: url += f'&start={start}'
 
@@ -153,7 +153,7 @@ class IntradayCandles:
 
         if delay not in ['delayed', 'realtime']: raise DelayError(f"Must provide a valid 'delay' parameter. Input: '{delay}'. Accepted values: 'delayed' or 'realtime'.")
         
-        url = f"{url_apis_v3}/marketdata/candles/intraday/{delay}/{market_type}/available_tickers"
+        url = f"{base_url}/api/v1/marketdata/br/b3/{delay}/intraday-candles/{market_type}/available_tickers"
 
         response = requests.request("GET", url,  headers=self.headers)
         if response.status_code == 200: return json.loads(response.text)

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/btgsolutions_dataservices/rest/quotes.py

@@ -1,7 +1,7 @@
 from typing import Optional
 from ..exceptions import BadResponse
 import requests
-from ..config import url_apis
+from ..config import base_url
 from .authenticator import Authenticator
 import json
 import pandas as pd
@@ -85,7 +85,7 @@ class Quotes:
         except:
             raise Exception(f"'tickers' parameter must be an array of strings.")
 
-        url = f"{url_apis}/marketdata/quotes/{market_type}/{mode}/tickers?tickers={tickers}"
+        url = f"{base_url}/api/v1/marketdata/br/b3/{mode}/quotes/{market_type}/tickers?tickers={tickers}"
 
         response = requests.request("GET", url,  headers=self.headers)
         if response.status_code == 200:
@@ -148,7 +148,7 @@ class Quotes:
         if not isinstance(ticker_type, str):
             raise Exception(f"'ticker_type' parameter must be a string. Input: '{ticker_type}'")
 
-        url = f"{url_apis}/marketdata/quotes/{market_type}/{mode}/top-bottom?variation={variation}&n={n}&type={ticker_type}"
+        url = f"{base_url}/api/v1/marketdata/br/b3/{mode}/quotes/{market_type}/top-bottom?variation={variation}&n={n}&type={ticker_type}"
 
         response = requests.request("GET", url,  headers=self.headers)
         if response.status_code == 200:
@@ -185,7 +185,7 @@ class Quotes:
         if mode not in self.available_modes:
             raise Exception(f"Must provide a valid 'mode' parameter. Input: '{mode}'. Accepted values: {self.available_modes}")
 
-        url = f"{url_apis}/marketdata/quotes/{market_type}/{mode}/available-tickers"
+        url = f"{base_url}/api/v1/marketdata/br/b3/{mode}/quotes/{market_type}/available-tickers"
         response = requests.request("GET", url,  headers=self.headers)
 
         if response.status_code == 200:

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/btgsolutions_dataservices/rest/reference_data.py

@@ -58,7 +58,7 @@ class ReferenceData:
             if raw_data:
                 return response.json()
             else:
-                return pd.DataFrame(response.json().values())
+                return pd.DataFrame(response.json())
         else:
             response = json.loads(response.text)
             raise BadResponse(f'Error: {response.get("ApiClientError", "")}')

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/btgsolutions_dataservices_python_client.egg-info/PKG-INFO

@@ -1,14 +1,25 @@
-Metadata-Version: 2.1
-Name: btgsolutions-dataservices-python-client
-Version: 3.1.0
+Metadata-Version: 2.4
+Name: btgsolutions_dataservices_python_client
+Version: 3.2.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.14
 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
 
@@ -98,11 +109,11 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Trades, throttle (1 second throttle)
+##### Books, throttle (1 second throttle)
 
 ```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', stream_type='throttle', instruments=['PETR4', 'VALE3'])
 ws.run(on_message=lambda message: print(message))
 
 ## The following is optional to keep the program running in a .py file:
@@ -138,19 +149,6 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Security List
-
-```python
-import btgsolutions_dataservices as btg
-ws = btg.MarketDataWebSocketClient(api_key='YOUR_API_KEY', data_type='securities', data_subtype='derivatives')
-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)
-```
-
 ##### Security Status
 
 ```python
@@ -181,20 +179,6 @@ ws.run(on_message=lambda message: print(message))
 #   sleep(1)
 ```
 
-##### Candles (1 second candles)
-
-```python
-import btgsolutions_dataservices as btg
-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
-# while True:
-#   sleep(1)
-```
-
 #### Intraday Candles
 
 ```python
@@ -232,7 +216,7 @@ last_event.get_trades(data_type='equities', ticker='VALE3')
 ```python
 import btgsolutions_dataservices as btg
 last_event = btg.TickerLastEvent(api_key='YOUR_API_KEY')
-last_event.get_tobs(data_type='stocks')
+last_event.get_tobs(data_type='equities')
 ```
 
 #### Ticker Last Trading Status
@@ -469,5 +453,3 @@ ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
 
-
-

{btgsolutions_dataservices_python_client-3.1.0 → btgsolutions_dataservices_python_client-3.2.1}/setup.py

@@ -22,7 +22,7 @@ description = "Python package containing several classes and data for extracting
 
 setup(
     name='btgsolutions_dataservices_python_client',
-    version='3.1.0',
+    version='3.2.1',
     description=description,
     long_description=long_description,
     long_description_content_type='text/markdown',