btgsolutions-dataservices-python-client 2.18.2__tar.gz → 3.0.0__tar.gz

{btgsolutions_dataservices_python_client-2.18.2 → btgsolutions_dataservices_python_client-3.0.0}/PKG-INFO

@@ -1,14 +1,25 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: btgsolutions_dataservices_python_client
-Version: 2.18.2
+Version: 3.0.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.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
 
@@ -469,5 +480,3 @@ ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
 
-
-

btgsolutions_dataservices_python_client-3.0.0/btgsolutions_dataservices/config.py

@@ -0,0 +1,137 @@
+base_url = "https://dataservices.btgpactualsolutions.com"
+
+# WS
+url_ws = "wss://dataservices.btgpactualsolutions.com/stream/"
+ws_br_b3_base_path = "/stream/v1/marketdata/br/b3/"
+
+# Rest
+url_apis = "https://dataservices.btgpactualsolutions.com/api/v2"
+url_api_v1 = "https://dataservices.btgpactualsolutions.com/api/v1"
+url_apis_v3 = "https://dataservices.btgpactualsolutions.com/api/v3"
+
+# WebSocket
+MAX_WS_RECONNECT_RETRIES = 5
+
+REALTIME = 'realtime'
+DELAYED = 'delayed'
+THROTTLE = 'throttle'
+PROCESSED = 'processed'
+
+BR = 'brazil'
+MX = 'mexico'
+CL = 'chile'
+
+B3 = 'b3'
+BMV = 'bmv'
+NASDAQ = 'nasdaq'
+
+TRADES = 'trades'
+PROCESSEDTRADES = 'processed-trades'
+INSTRUMENTSTATUS = 'instrument_status'
+SETTLEMENTPRICES = 'settlement-price'
+BOOKS = 'books'
+INDICES = 'indices'
+
+ALL = 'all'
+STOCKS = 'stocks'
+OPTIONS = 'options'
+DERIVATIVES = 'derivatives'
+
+VALID_STREAM_TYPES = [REALTIME, DELAYED, THROTTLE]
+VALID_COUNTRIES = [BR, MX, CL]
+VALID_EXCHANGES = [B3, BMV, NASDAQ]
+VALID_MARKET_DATA_TYPES = [
+    TRADES,
+    PROCESSEDTRADES,
+    BOOKS,
+    INDICES,
+    INSTRUMENTSTATUS,
+    SETTLEMENTPRICES
+]
+VALID_MARKET_DATA_SUBTYPES = [ALL, STOCKS, OPTIONS, DERIVATIVES]
+
+FEED_A = "A"
+FEED_B = "B"
+VALID_FEEDS = [FEED_A, FEED_B]
+
+market_data_socket_urls = {
+    B3: {
+        TRADES: {
+            REALTIME: {
+                STOCKS: f'{url}{ws_br_b3_base_path}trade/{STOCKS}',
+                OPTIONS: f'{url}{ws_br_b3_base_path}trade/{OPTIONS}',
+                DERIVATIVES: f'{url}{ws_br_b3_base_path}trade/{DERIVATIVES}',
+            },
+            DELAYED: {
+                STOCKS: f'{url}{ws_br_b3_base_path}{DELAYED}/trade/{STOCKS}/{DELAYED}',
+                OPTIONS: f'{url}{ws_br_b3_base_path}{DELAYED}/trade/{OPTIONS}/{DELAYED}',
+                DERIVATIVES: f"{url}{ws_br_b3_base_path}{DELAYED}/trade/{DERIVATIVES}/{DELAYED}",
+            },
+        },
+        PROCESSEDTRADES: {
+            REALTIME: {
+                STOCKS: f'{url}{ws_br_b3_base_path}{PROCESSED}-trade/{STOCKS}',
+                OPTIONS: f'{url}{ws_br_b3_base_path}{PROCESSED}-trade/{OPTIONS}',
+                DERIVATIVES: f'{url}{ws_br_b3_base_path}{PROCESSED}-trade/{DERIVATIVES}',
+            },
+        },
+        BOOKS: {
+            REALTIME: {
+                STOCKS: f'{url}{ws_br_b3_base_path}book-snapshot-mbp/{STOCKS}',
+                OPTIONS: f'{url}{ws_br_b3_base_path}book-snapshot-mbp/{OPTIONS}',
+                DERIVATIVES: f'{url}{ws_br_b3_base_path}book-snapshot-mbp/{DERIVATIVES}',
+            },
+            THROTTLE: {
+                STOCKS: f"{url}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{STOCKS}",
+                OPTIONS: f"{url}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{OPTIONS}",
+                DERIVATIVES: f"{url}{ws_br_b3_base_path}throttled/book-snapshot-mbp/{DERIVATIVES}",
+            },
+        },
+        INDICES: {
+            REALTIME: {
+                ALL: f"{url_ws}v2/marketdata/{INDICES}",
+            },
+            DELAYED: {
+                ALL: f"{url_ws}v2/marketdata/{INDICES}/{DELAYED}",
+            }
+        },
+        INSTRUMENTSTATUS: {
+            REALTIME: {
+                STOCKS: f"{url}{ws_br_b3_base_path}instrument-status/{STOCKS}",
+                DERIVATIVES: f"{url}{ws_br_b3_base_path}instrument-status/{DERIVATIVES}",
+                OPTIONS: f"{url}{ws_br_b3_base_path}instrument-status/{OPTIONS}",
+            }
+        },
+        SETTLEMENTPRICES: {
+            REALTIME: {
+                ALL: f"{url}{ws_br_b3_base_path}{SETTLEMENTPRICES}",
+            }
+        }
+    },
+    BMV: {
+        TRADES: {
+            REALTIME: {
+                ALL: f'{url_ws}v1/marketdata/bmv/{TRADES}',
+            },
+        },
+    },
+    NASDAQ: {
+        TRADES: {
+            REALTIME: {
+                ALL: f'{url_ws}v1/marketdata/us/nasdaq/{TRADES}',
+            }
+        }
+    }
+}
+
+market_data_feedb_socket_urls = {
+}
+
+hfn_socket_urls = {
+    BR: {
+        REALTIME: f'{url_ws}v2/hfn/{BR}',
+    },
+    CL: {
+        REALTIME: f'{url_ws}v2/hfn/{CL}',
+    },
+}

{btgsolutions_dataservices_python_client-2.18.2 → btgsolutions_dataservices_python_client-3.0.0}/btgsolutions_dataservices/rest/reference_data.py

@@ -1,7 +1,7 @@
 from typing import List, Optional
 from ..exceptions import BadResponse
 import requests
-from ..config import url_apis
+from ..config import base_url
 from .authenticator import Authenticator
 import pandas as pd
 import json
@@ -51,7 +51,7 @@ class ReferenceData:
         if not isinstance(tickers, list) or len(tickers) == 0:
             raise BadResponse(f'Error: Must provide a valid list of tickers')
         
-        url = f"{url_apis}/marketdata/instrument/specs/all/instrument_data/batch?tickers={','.join(tickers)}"
+        url = f"{base_url}/api/v1/marketdata/br/b3/snapshot/instruments/batch?tickers={','.join(tickers)}"
 
         response = requests.request("GET", url,  headers=self.headers)
         if response.status_code == 200:

{btgsolutions_dataservices_python_client-2.18.2 → btgsolutions_dataservices_python_client-3.0.0}/btgsolutions_dataservices/rest/ticker_last_event.py

@@ -1,7 +1,7 @@
 from typing import Optional, List
 from ..exceptions import BadResponse
 import requests
-from ..config import url_api_v1
+from ..config import base_url
 from .authenticator import Authenticator
 import pandas as pd
 import json
@@ -24,7 +24,7 @@ class TickerLastEvent:
     >>> )
 
     >>> last_event.get_tob(
-    >>>     data_type = 'stocks',
+    >>>     data_type = 'derivatives',
     >>>     raw_data = False
     >>> )
 
@@ -43,7 +43,7 @@ class TickerLastEvent:
 
         self.available_data_types = {
             "trades": ['equities', 'derivatives'],
-            "books": ['stocks', 'derivatives', 'options']
+            "books": ['equities', 'derivatives']
         }
 
     def get_trades(self, data_type:str, ticker:str, raw_data:bool=False):
@@ -67,7 +67,7 @@ class TickerLastEvent:
         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}"
+        url = f"{base_url}/api/v1/marketdata/br/b3/snapshot/trades/{data_type}?ticker={ticker}"
 
         response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
         if response.status_code == 200:
@@ -89,7 +89,7 @@ class TickerLastEvent:
         data_type: str
             Market Data Type.
             Field is required. 
-            Example: 'stocks', 'derivatives', 'options'.
+            Example: 'equities', 'derivatives'.
         raw_data: bool
             If false, returns data in a dataframe. If true, returns raw data.
             Field is not required. Default: False.
@@ -98,7 +98,7 @@ class TickerLastEvent:
         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"
+        url = f"{base_url}/api/v1/marketdata/br/b3/snapshot/book/tob/{data_type}/batch"
 
         response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
 
@@ -131,9 +131,9 @@ class TickerLastEvent:
 
         if tickers:
             tickers = ','.join(tickers)
-            url = f"{url_api_v1}/marketdata/last-event/status/all/batch?tickers={tickers}"
+            url = f"{base_url}/api/v1/marketdata/br/b3/snapshot/status/batch?tickers={tickers}"
         else:
-            url = f"{url_api_v1}/marketdata/last-event/status/all/batch"
+            url = f"{base_url}/api/v1/marketdata/br/b3/snapshot/status/batch"
 
         response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
         if response.status_code == 200:
@@ -159,7 +159,7 @@ class TickerLastEvent:
         data_type: str
             Market Data Type.
             Field is required. 
-            Example: 'equities', 'derivatives', 'options', 'stocks'.
+            Example: 'equities', 'derivatives'.
         """
 
         if type not in self.available_data_types:
@@ -168,8 +168,8 @@ class TickerLastEvent:
         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"
+        url = f"{base_url}/api/v1/marketdata/br/b3/snapshot/trades/{data_type}/available-tickers" if type == "trades" else \
+            f"{base_url}/api/v1/marketdata/br/b3/snapshot/book/tob/{data_type}/available-tickers"
 
         response = requests.request("GET", url,  headers={"authorization": f"Bearer {self.authenticator.token}"})
         if response.status_code == 200:

{btgsolutions_dataservices_python_client-2.18.2 → btgsolutions_dataservices_python_client-3.0.0}/btgsolutions_dataservices_python_client.egg-info/PKG-INFO

@@ -1,14 +1,25 @@
-Metadata-Version: 2.1
-Name: btgsolutions-dataservices-python-client
-Version: 2.18.2
+Metadata-Version: 2.4
+Name: btgsolutions_dataservices_python_client
+Version: 3.0.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.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
 
@@ -469,5 +480,3 @@ ref = btg.ReferenceData(api_key='YOUR_API_KEY')
 ref.ticker_reference(tickers=['VALE3','PETR4'])
 ```
 
-
-

{btgsolutions_dataservices_python_client-2.18.2 → btgsolutions_dataservices_python_client-3.0.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.18.2',
+    version='3.0.0',
     description=description,
     long_description=long_description,
     long_description_content_type='text/markdown',

btgsolutions_dataservices_python_client-2.18.2/btgsolutions_dataservices/config.py

@@ -1,179 +0,0 @@
-# WS
-url_ws = "wss://dataservices.btgpactualsolutions.com/stream/"
-
-# Rest
-url_apis = "https://dataservices.btgpactualsolutions.com/api/v2"
-url_api_v1 = "https://dataservices.btgpactualsolutions.com/api/v1"
-url_apis_v3 = "https://dataservices.btgpactualsolutions.com/api/v3"
-
-# WebSocket
-MAX_WS_RECONNECT_RETRIES = 5
-
-REALTIME = 'realtime'
-DELAYED = 'delayed'
-THROTTLE = 'throttle'
-PROCESSED = 'processed'
-
-BR = 'brazil'
-MX = 'mexico'
-CL = 'chile'
-
-B3 = 'b3'
-BMV = 'bmv'
-NASDAQ = 'nasdaq'
-
-SECURITIES = 'securities'
-TRADES = 'trades'
-PROCESSEDTRADES = 'processed-trades'
-INSTRUMENTSTATUS = 'instrument_status'
-SETTLEMENTPRICES = 'settlement-price'
-BOOKS = 'books'
-INDICES = 'indices'
-CANDLES1S = 'candles-1S'
-CANDLES1M = 'candles-1M'
-STOPLOSS = 'stoploss'
-
-ALL = 'all'
-STOCKS = 'stocks'
-OPTIONS = 'options'
-DERIVATIVES = 'derivatives'
-
-VALID_STREAM_TYPES = [REALTIME, DELAYED, THROTTLE]
-VALID_COUNTRIES = [BR, MX, CL]
-VALID_EXCHANGES = [B3, BMV, NASDAQ]
-VALID_MARKET_DATA_TYPES = [
-    SECURITIES,
-    TRADES,
-    PROCESSEDTRADES,
-    BOOKS,
-    INDICES,
-    CANDLES1S,
-    CANDLES1M,
-    STOPLOSS,
-    INSTRUMENTSTATUS,
-    SETTLEMENTPRICES
-]
-VALID_MARKET_DATA_SUBTYPES = [ALL, STOCKS, OPTIONS, DERIVATIVES]
-
-FEED_A = "A"
-FEED_B = "B"
-VALID_FEEDS = [FEED_A, FEED_B]
-
-market_data_socket_urls = {
-    B3: {
-        TRADES: {
-            REALTIME: {
-                STOCKS: f'{url_ws}v2/marketdata/trade/{STOCKS}',
-                OPTIONS: f'{url_ws}v2/marketdata/trade/{OPTIONS}',
-                DERIVATIVES: f'{url_ws}v2/marketdata/trade/{DERIVATIVES}',
-            },
-            DELAYED: {
-                STOCKS: f'{url_ws}v2/marketdata/trade/{STOCKS}/{DELAYED}',
-                OPTIONS: f'{url_ws}v2/marketdata/trade/{OPTIONS}/{DELAYED}',
-                DERIVATIVES: f"{url_ws}v2/marketdata/trade/{DERIVATIVES}/{DELAYED}",
-            },
-            THROTTLE: {
-                STOCKS: f"{url_ws}v2/marketdata/{THROTTLE}/trade/{STOCKS}",
-                OPTIONS: f"{url_ws}v2/marketdata/{THROTTLE}/trade/{OPTIONS}",
-                DERIVATIVES: f"{url_ws}v2/marketdata/{THROTTLE}/trade/{DERIVATIVES}",
-            },
-        },
-        PROCESSEDTRADES: {
-            REALTIME: {
-                STOCKS: f'{url_ws}v2/marketdata/{PROCESSED}/trade/{STOCKS}',
-                OPTIONS: f'{url_ws}v2/marketdata/{PROCESSED}/trade/{OPTIONS}',
-                DERIVATIVES: f'{url_ws}v2/marketdata/{PROCESSED}/trade/{DERIVATIVES}',
-            },
-        },
-        BOOKS: {
-            REALTIME: {
-                STOCKS: f'{url_ws}v2/marketdata/book/{STOCKS}',
-                OPTIONS: f'{url_ws}v2/marketdata/book/{OPTIONS}',
-                DERIVATIVES: f'{url_ws}v2/marketdata/book/{DERIVATIVES}',
-            },
-            THROTTLE: {
-                STOCKS: f"{url_ws}v2/marketdata/{THROTTLE}/book/{STOCKS}",
-                OPTIONS: f"{url_ws}v2/marketdata/{THROTTLE}/book/{OPTIONS}",
-                DERIVATIVES: f"{url_ws}v2/marketdata/{THROTTLE}/book/{DERIVATIVES}",
-            },
-        },
-        SECURITIES: {
-            REALTIME: {
-                STOCKS: f"{url_ws}v1/marketdata/sec_list/{STOCKS}",
-                OPTIONS: f"{url_ws}v1/marketdata/sec_list/{OPTIONS}",
-                DERIVATIVES: f"{url_ws}v1/marketdata/sec_list/{DERIVATIVES}",
-            },
-        },
-        INDICES: {
-            REALTIME: {
-                ALL: f"{url_ws}v2/marketdata/{INDICES}",
-            },
-            DELAYED: {
-                ALL: f"{url_ws}v2/marketdata/{INDICES}/{DELAYED}",
-            }
-        },
-        CANDLES1S: {
-            REALTIME: {
-                STOCKS: f"{url_ws}v1/marketdata/candles/1S/{STOCKS}",
-                DERIVATIVES: f"{url_ws}v1/marketdata/candles/1S/{DERIVATIVES}",
-            },
-        },
-        CANDLES1M: {
-            REALTIME: {
-                STOCKS: f"{url_ws}v1/marketdata/candles/1M/{STOCKS}",
-                DERIVATIVES: f"{url_ws}v1/marketdata/candles/1M/{DERIVATIVES}",
-            },
-        },
-        STOPLOSS: {
-            REALTIME: {
-                STOCKS: f"{url_ws}v1/marketdata/{STOPLOSS}/{STOCKS}",
-                DERIVATIVES: f"{url_ws}v1/marketdata/{STOPLOSS}/{DERIVATIVES}",
-            },
-        },
-        INSTRUMENTSTATUS: {
-            REALTIME: {
-                STOCKS: f"{url_ws}v2/marketdata/{INSTRUMENTSTATUS}/{STOCKS}",
-                DERIVATIVES: f"{url_ws}v2/marketdata/{INSTRUMENTSTATUS}/{DERIVATIVES}",
-                OPTIONS: f"{url_ws}v2/marketdata/{INSTRUMENTSTATUS}/{OPTIONS}",
-            }
-        },
-        SETTLEMENTPRICES: {
-            REALTIME: {
-                ALL: f"{url_ws}v2/marketdata/{SETTLEMENTPRICES}",
-            }
-        }
-    },
-    BMV: {
-        TRADES: {
-            REALTIME: {
-                ALL: f'{url_ws}v1/marketdata/bmv/{TRADES}',
-            },
-        },
-    },
-    NASDAQ: {
-        TRADES: {
-            REALTIME: {
-                ALL: f'{url_ws}v1/marketdata/us/nasdaq/{TRADES}',
-            }
-        }
-    }
-}
-
-market_data_feedb_socket_urls = {
-    B3: {
-        BOOKS: {
-            REALTIME: {
-                OPTIONS: f'{url_ws}v2/feedb/marketdata/book/{OPTIONS}',
-            }
-        }
-    }
-}
-
-hfn_socket_urls = {
-    BR: {
-        REALTIME: f'{url_ws}v2/hfn/{BR}',
-    },
-    CL: {
-        REALTIME: f'{url_ws}v2/hfn/{CL}',
-    },
-}