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

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

@@ -1,10 +1,10 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: btgsolutions_dataservices_python_client
-Version: 3.2.7
+Version: 3.2.8
 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
-Requires-Python: >=3.9,<3.14
+Requires-Python: >=3.9,<3.15
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pandas>=2.2.2
@@ -12,14 +12,6 @@ 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
 
@@ -245,7 +237,7 @@ last_event.get()
 ```python
 import btgsolutions_dataservices as btg
 hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
-hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False)
+hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False, round=False)
 ```
 
 ##### Intraday
@@ -253,7 +245,7 @@ hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks',
 ```python
 import btgsolutions_dataservices as btg
 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)
+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, round=True)
 ```
 
 ##### Available Tickers
@@ -272,6 +264,32 @@ 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).plot(x='candle_time', y='close_price', kind='scatter')
 ```
 
+#### Historical Candles Crypto
+
+##### Interday
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_interday_history_candles(ticker='BTC', currency='BRL', exchange='consolidated', start_date='2025-06-01', end_date='2025-07-01', timezone='UTC', raw_data=False)
+```
+
+##### Intraday
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_intraday_history_candles(ticker='BTC', currency='BRL', exchange='consolidated', date='2025-06-01', candle='1h', timezone='America/Sao_Paulo', raw_data=False)
+```
+
+##### Available Tickers
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_available_tickers(exchange='coinbase', date='2023-01-13')
+```
+
 #### Historical Tick Data (Bulk Data)
 
 ##### Available Tickers

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

@@ -222,7 +222,7 @@ last_event.get()
 ```python
 import btgsolutions_dataservices as btg
 hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
-hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False)
+hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False, round=False)
 ```
 
 ##### Intraday
@@ -230,7 +230,7 @@ hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks',
 ```python
 import btgsolutions_dataservices as btg
 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)
+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, round=True)
 ```
 
 ##### Available Tickers
@@ -249,6 +249,32 @@ 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).plot(x='candle_time', y='close_price', kind='scatter')
 ```
 
+#### Historical Candles Crypto
+
+##### Interday
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_interday_history_candles(ticker='BTC', currency='BRL', exchange='consolidated', start_date='2025-06-01', end_date='2025-07-01', timezone='UTC', raw_data=False)
+```
+
+##### Intraday
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_intraday_history_candles(ticker='BTC', currency='BRL', exchange='consolidated', date='2025-06-01', candle='1h', timezone='America/Sao_Paulo', raw_data=False)
+```
+
+##### Available Tickers
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_available_tickers(exchange='coinbase', date='2023-01-13')
+```
+
 #### Historical Tick Data (Bulk Data)
 
 ##### Available Tickers

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

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

{btgsolutions_dataservices_python_client-3.2.7 → btgsolutions_dataservices_python_client-3.2.8}/btgsolutions_dataservices/rest/historical_candles.py

@@ -24,6 +24,7 @@ class HistoricalCandles:
     >>>     end_date = '2023-10-20', 
     >>>     rmv_after_market = True,
     >>>     timezone = 'UTC',
+    >>>     round = True,
     >>>     raw_data = False
     >>> )
 
@@ -37,6 +38,7 @@ class HistoricalCandles:
     >>>     rmv_after_market = True,
     >>>     timezone = 'UTC',
     >>>     candle='1m',
+    >>>     round = True,
     >>>     raw_data = False
     >>> )
 
@@ -63,7 +65,8 @@ class HistoricalCandles:
         corporate_events_adj:bool,
         rmv_after_market:bool,
         timezone:str,
-        raw_data:bool=False
+        raw_data:bool=False,
+        round:bool=True
     ):
         """
         This method provides historical candles for a given ticket in determined period.
@@ -93,12 +96,15 @@ class HistoricalCandles:
         raw_data: bool
             If false, returns data in a dataframe. If true, returns raw data.
             Field is not required. Default: False.
+        round: bool
+            Apply rounding to prices.
+            Field is not required. Default: True.
         """     
         
         if market_type not in ['stocks', 'derivatives']:
             raise MarketTypeError(f'Allowed values: "stocks" or "derivatives". Input value: "{market_type}".')
         
-        url = f"{url_apis_v3}/marketdata/history/candles/intraday/{market_type}?ticker={ticker}&corporate_events_adj={corporate_events_adj}&rmv_after_market={rmv_after_market}&timezone={timezone}&date={date}&candle={candle}"
+        url = f"{url_apis_v3}/marketdata/history/candles/intraday/{market_type}?ticker={ticker}&corporate_events_adj={corporate_events_adj}&rmv_after_market={rmv_after_market}&timezone={timezone}&date={date}&candle={candle}&round={round}"
         response = requests.request("GET", url,  headers=self.headers)
         if response.status_code == 200:
             response_data = json.loads(response.text)
@@ -116,7 +122,8 @@ class HistoricalCandles:
         corporate_events_adj:bool,
         rmv_after_market:bool,
         timezone:str,
-        raw_data:bool=False
+        raw_data:bool=False,
+        round:bool=True
     ):
         """
         This method provides historical candles for a given ticket in determined period.
@@ -146,12 +153,15 @@ class HistoricalCandles:
         raw_data: bool
             If false, returns data in a dataframe. If true, returns raw data.
             Field is not required. Default: False.
+        round: bool
+            Apply rounding to prices.
+            Field is not required. Default: True.
         """     
         
         if market_type not in ['stocks', 'derivatives']:
             raise MarketTypeError(f'Allowed values: "stocks" or "derivatives". Input value: "{market_type}".')
         
-        url = f"{url_apis_v3}/marketdata/history/candles/interday/{market_type}?ticker={ticker}&corporate_events_adj={corporate_events_adj}&rmv_after_market={rmv_after_market}&timezone={timezone}&start_date={start_date}&end_date={end_date}"
+        url = f"{url_apis_v3}/marketdata/history/candles/interday/{market_type}?ticker={ticker}&corporate_events_adj={corporate_events_adj}&rmv_after_market={rmv_after_market}&timezone={timezone}&start_date={start_date}&end_date={end_date}&round={round}"
         response = requests.request("GET", url,  headers=self.headers)
         if response.status_code == 200:
             response_data = json.loads(response.text)

btgsolutions_dataservices_python_client-3.2.8/btgsolutions_dataservices/rest/historical_candles_crypto.py

@@ -0,0 +1,177 @@
+from typing import Optional
+from ..exceptions import BadResponse, MarketTypeError
+import requests
+from ..config import url_apis_v3
+from .authenticator import Authenticator
+import json
+import pandas as pd
+
+class HistoricalCandlesCrypto:
+    """
+    This class provides historical candles for cryptocurrencies.
+
+    Available tickers: ETH, SOL, BTC
+    Available exchanges: coinbase, mercado_bitcoin, consolidated
+    Available currencies: BRL, USD
+    Available candles: '1s', '30s', '1m', '5m', '15m', '30m', '1h'
+
+    * Main use case - Interday:
+
+    >>> from btgsolutions_dataservices import HistoricalCandlesCrypto
+    >>> hist_candles = HistoricalCandlesCrypto(
+    >>>     api_key='YOUR_API_KEY',
+    >>> )
+    >>> hist_candles.get_interday_history_candles(
+    >>>     ticker = 'BTC',
+    >>>     currency = 'BRL',
+    >>>     exchange = 'consolidated',
+    >>>     start_date = '2025-06-01',
+    >>>     end_date = '2025-07-01', 
+    >>>     timezone = 'UTC',
+    >>>     raw_data = False
+    >>> )
+
+    * Main use case - Intraday:
+
+    >>> hist_candles.get_intraday_history_candles(
+    >>>     ticker = 'BTC',
+    >>>     currency = 'BRL',
+    >>>     exchange = 'consolidated',
+    >>>     date = '2025-06-01', 
+    >>>     timezone = 'America/Sao_Paulo',
+    >>>     candle='1h',
+    >>>     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}"}
+
+    def get_intraday_history_candles(
+        self,
+        ticker:str,
+        currency:str,
+        exchange:str,
+        date:str,
+        candle:str,
+        timezone:str,
+        raw_data:bool=False
+    ):
+        """
+        This method provides historical intraday candles for cryptocurrencies.
+
+        Parameters
+        ----------------
+        ticker: str
+            Cryptocurrency ticker.
+            Field is required. Allowed values: 'BTC', 'ETH', 'SOL'.
+        currency: str
+            Currency for the prices.
+            Field is required. Allowed values: 'BRL' or 'USD'.
+        exchange: str
+            Exchange name.
+            Field is required. Allowed values: 'coinbase', 'mercado_bitcoin', 'consolidated'.
+        date: string<date>
+            Date of requested data. Format: "YYYY-MM-DD".
+            Field is required. Example: '2025-06-01'.
+        candle: str
+            Candle period.
+            Field is required. Allowed values: '1s', '30s', '1m', '5m', '15m', '30m', '1h'.
+        timezone: str
+            Timezone of the datetime.
+            Field is required. Allowed values: 'America/Sao_Paulo' or 'UTC'.
+        raw_data: bool
+            If false, returns data in a dataframe. If true, returns raw data.
+            Field is not required. Default: False.
+        """     
+        
+        url = f"{url_apis_v3}/marketdata/history/candles/intraday/crypto?ticker={ticker}&currency={currency}&exchange={exchange}&date={date}&candle={candle}&timezone={timezone}"
+        response = requests.request("GET", url,  headers=self.headers)
+        if response.status_code == 200:
+            response_data = json.loads(response.text)
+            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", "")}')
+    
+    def get_interday_history_candles(
+        self,
+        ticker:str,
+        currency:str,
+        exchange:str,
+        start_date:str,
+        end_date:str,
+        timezone:str,
+        raw_data:bool=False
+    ):
+        """
+        This method provides historical daily candles for cryptocurrencies.
+
+        Parameters
+        ----------------
+        ticker: str
+            Cryptocurrency ticker.
+            Field is required. Allowed values: 'BTC', 'ETH', 'SOL'.
+        currency: str
+            Currency for the prices.
+            Field is required. Allowed values: 'BRL' or 'USD'.
+        exchange: str
+            Exchange name.
+            Field is required. Allowed values: 'coinbase', 'mercado_bitcoin', 'consolidated'.
+        start_date: string<date>
+            Start date of analysis. Format: "YYYY-MM-DD".
+            Field is required. Example: '2025-06-01'.
+        end_date: string<date>
+            End date of analysis. Format: "YYYY-MM-DD".
+            Field is required. Example: '2025-07-01'.
+        timezone: str
+            Timezone of the datetime.
+            Field is required. Allowed values: 'America/Sao_Paulo' or 'UTC'.
+        raw_data: bool
+            If false, returns data in a dataframe. If true, returns raw data.
+            Field is not required. Default: False.
+        """     
+        
+        url = f"{url_apis_v3}/marketdata/history/candles/interday/crypto?ticker={ticker}&currency={currency}&exchange={exchange}&start_date={start_date}&end_date={end_date}&timezone={timezone}"
+        response = requests.request("GET", url,  headers=self.headers)
+        if response.status_code == 200:
+            response_data = json.loads(response.text)
+            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", "")}')
+
+    def get_available_tickers(
+        self,
+        exchange:str,
+        date:str,
+    ):
+        """
+        This method provides all cryptocurrency tickers available for query.   
+
+        Parameters
+        ----------------
+        exchange: str
+            Exchange name.
+            Field is required. Allowed values: 'coinbase', 'mercado_bitcoin', 'consolidated'.
+        date: string<date>
+            Date of requested data. Format: "YYYY-MM-DD".
+            Field is required. Example: '2023-01-13'.
+        """
+
+        url = f"{url_apis_v3}/marketdata/history/candles/available-tickers/crypto?date={date}&exchange={exchange}"
+
+        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-3.2.7 → btgsolutions_dataservices_python_client-3.2.8/btgsolutions_dataservices_python_client.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: btgsolutions_dataservices_python_client
-Version: 3.2.7
+Version: 3.2.8
 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
-Requires-Python: >=3.9,<3.14
+Requires-Python: >=3.9,<3.15
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pandas>=2.2.2
@@ -12,14 +12,6 @@ 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
 
@@ -245,7 +237,7 @@ last_event.get()
 ```python
 import btgsolutions_dataservices as btg
 hist_candles = btg.HistoricalCandles(api_key='YOUR_API_KEY')
-hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False)
+hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks', corporate_events_adj=True, start_date='2023-10-01', end_date='2023-10-13', rmv_after_market=True, timezone='UTC', raw_data=False, round=False)
 ```
 
 ##### Intraday
@@ -253,7 +245,7 @@ hist_candles.get_interday_history_candles(ticker='PETR4',  market_type='stocks',
 ```python
 import btgsolutions_dataservices as btg
 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)
+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, round=True)
 ```
 
 ##### Available Tickers
@@ -272,6 +264,32 @@ 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).plot(x='candle_time', y='close_price', kind='scatter')
 ```
 
+#### Historical Candles Crypto
+
+##### Interday
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_interday_history_candles(ticker='BTC', currency='BRL', exchange='consolidated', start_date='2025-06-01', end_date='2025-07-01', timezone='UTC', raw_data=False)
+```
+
+##### Intraday
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_intraday_history_candles(ticker='BTC', currency='BRL', exchange='consolidated', date='2025-06-01', candle='1h', timezone='America/Sao_Paulo', raw_data=False)
+```
+
+##### Available Tickers
+
+```python
+import btgsolutions_dataservices as btg
+hist_candles_crypto = btg.HistoricalCandlesCrypto(api_key='YOUR_API_KEY')
+hist_candles_crypto.get_available_tickers(exchange='coinbase', date='2023-01-13')
+```
+
 #### Historical Tick Data (Bulk Data)
 
 ##### Available Tickers

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

@@ -15,6 +15,7 @@ btgsolutions_dataservices/rest/company_data.py
 btgsolutions_dataservices/rest/corporate_events.py
 btgsolutions_dataservices/rest/hfn.py
 btgsolutions_dataservices/rest/historical_candles.py
+btgsolutions_dataservices/rest/historical_candles_crypto.py
 btgsolutions_dataservices/rest/intraday_candles.py
 btgsolutions_dataservices/rest/intraday_tick_data.py
 btgsolutions_dataservices/rest/public_sources.py

{btgsolutions_dataservices_python_client-3.2.7 → btgsolutions_dataservices_python_client-3.2.8}/setup.py

@@ -38,5 +38,5 @@ setup(
     packages=find_packages(),
     url="https://github.com/BTG-Pactual-Solutions/btgsolutions-dataservices-python-client",
     install_requires=install_requires,
-    python_requires=">=3.9,<3.14",
+    python_requires=">=3.9,<3.15",
 )