btgsolutions-dataservices-python-client 3.2.12__tar.gz → 4.0.0__tar.gz

{btgsolutions_dataservices_python_client-3.2.12/btgsolutions_dataservices_python_client.egg-info → btgsolutions_dataservices_python_client-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: btgsolutions_dataservices_python_client
-Version: 3.2.12
+Version: 4.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
@@ -12,6 +12,14 @@ 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
 
@@ -375,9 +383,23 @@ bulk_data.get_compressed_data(channel='98', date='2026-01-30', data_type='instru
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.HFNWebSocketClient(api_key='YOUR_API_KEY', country='brazil')
+ws = btg.HFNWebSocketClient(api_key='YOUR_API_KEY')
 ws.run(on_message=lambda message: print(message))
 
+# Subscribe to live economy news in Portuguese
+ws.subscribe(settings={'feed': 'economy', 'text_language': 'portuguese'})
+
+# Request latest news on demand (without subscribing to the live stream)
+ws.latest_news(settings={'feed': 'crypto', 'limit': '10'})
+
+# Get available filter values
+ws.available_filters(settings={})
+
+# Stop receiving broadcasts (keeps connection open)
+ws.unsubscribe()
+
+ws.close()
+
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
@@ -389,7 +411,22 @@ ws.run(on_message=lambda message: print(message))
 ```python
 import btgsolutions_dataservices as btg
 hfn = btg.HighFrequencyNews(api_key='YOUR_API_KEY')
-hfn.latest_news()
+
+# Latest news with filters
+hfn.get_latest_news(feed='economy', text_language='portuguese', limit=10)
+
+# Latest news by ticker tags
+hfn.get_latest_news(tags=['PETR4', 'VALE3'])
+
+# Historical news for a date range
+hfn.get_historical_news(
+    start_date='2026-05-01T00:00:00.000Z',
+    end_date='2026-05-08T23:59:59.999Z',
+    feed='economy',
+)
+
+# Available filter values
+hfn.get_available_filters()
 ```
 
 #### OPA
@@ -484,6 +521,98 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.all_financial_tables(ticker='PETR4')
 ```
 
+#### Alternative Data - Metadata
+
+```python
+import btgsolutions_dataservices as btg
+meta = btg.AlternativeDataMetadata(api_key='YOUR_API_KEY')
+meta.get_company_directory(query='PETROBRAS', jurisdiction='BR')
+meta.get_company_sector(identifier='PETR4')
+meta.get_taxonomy(system='b3')
+meta.get_cnae(code='6422100')
+meta.get_sector_companies(sector='Petróleo, Gás e Biocombustíveis')
+meta.get_sectors_summary()
+meta.get_financial_statement_types()
+meta.get_datasets()
+meta.get_available_assets(dataset='maximum_theoretical_margin', prefix='PETR')
+meta.get_available_indicators()
+```
+
+#### Alternative Data - Companies
+
+```python
+import btgsolutions_dataservices as btg
+companies = btg.AlternativeDataCompanies(api_key='YOUR_API_KEY')
+companies.get_board(company_id='VALE3', body='board')
+companies.get_governance_summary(company_id='ITUB4')
+companies.get_governance_history(company_id='PETR4', start_date='2023-01-01', end_date='2024-12-31')
+companies.get_governance_documents(company_id='PETR4', start_date='2024-01-01', end_date='2024-12-31')
+companies.get_governance_compensation(company_id='VALE3', fiscal_year='2024')
+companies.get_governance_related_party(company_id='ITUB4')
+companies.get_governance_beneficial_ownership(company_id='VALE3')
+companies.get_corporate_registry(company_id='PETR4', direction='partners')
+companies.get_corporate_registry(company_id='PETR4', direction='investees')
+companies.get_insider_trades(company_id='AAPL', start_date='2024-01-01', end_date='2024-12-31')
+companies.get_board_changes(company_id='VALE3', event='appointed')
+companies.get_financial_statements(company_id='PETR4', statement='income_statement', quarter='Q42024')
+companies.get_financial_notes(company_id='VALE3', quarter='Q42024')
+companies.get_disclosures(company_id='PETR4', document_type='repurchase')
+companies.get_disclosures(company_id='PETR4', document_type='insider')
+```
+
+#### Alternative Data - People
+
+```python
+import btgsolutions_dataservices as btg
+people = btg.AlternativeDataPeople(api_key='YOUR_API_KEY')
+people.get_appointments(person_id='slug:Jean Paul Lemann', active_only=True)
+people.get_appointments(person_id='slug:Jean Paul Lemann', group_by='company')
+```
+
+#### Alternative Data - Funds
+
+```python
+import btgsolutions_dataservices as btg
+funds = btg.AlternativeDataFunds(api_key='YOUR_API_KEY')
+funds.get_holdings(fund_id='73.232.530/0001-46', reference_date='2024-12-31')
+funds.get_exposures(fund_id='73.232.530/0001-46', exposure_type='asset_class')
+funds.get_history(fund_id='73.232.530/0001-46', start_date='2024-01-01', end_date='2024-12-31')
+funds.get_lookthrough(fund_id='73.232.530/0001-46')
+funds.get_manager_aggregate_holdings(manager_id='ITAÚ ASSET MANAGEMENT')
+```
+
+#### Alternative Data - Ownership
+
+```python
+import btgsolutions_dataservices as btg
+ownership = btg.AlternativeDataOwnership(api_key='YOUR_API_KEY')
+ownership.get_top_shareholders(company_id='VALE3', limit=10)
+ownership.get_ownership_current(company_id='ITUB4')
+ownership.get_ownership_history(company_id='PETR4', start_date='2023-01-01', end_date='2024-12-31')
+ownership.get_ownership_change_events(company_id='VALE3', start_date='2024-01-01', end_date='2024-12-31')
+ownership.get_ownership_official_notices(company_id='PETR4')
+ownership.get_ownership_control_group(company_id='VALE3')
+ownership.get_ownership_free_float(company_id='PETR4')
+ownership.get_shareholder_holdings(shareholder_id='00.000.000/0001-91')
+ownership.get_institutional_holders(identifier='VALE3')
+ownership.get_fund_holders(identifier='PETR4', identifier_type='b3_ticker')
+```
+
+#### Alternative Data - Macro & Markets
+
+```python
+import btgsolutions_dataservices as btg
+macro = btg.AlternativeDataMacroMarkets(api_key='YOUR_API_KEY')
+macro.get_macro_indicators(indicator='selic')
+macro.get_macro_indicators(indicator='ipca_contributions', start_date='2024-01', end_date='2024-12')
+macro.get_macro_indicators(indicator='gdp', type='yoy')
+macro.get_macro_indicators(indicator='comexstat', year='2024', state='SP')
+macro.get_macro_indicators(indicator='rreo', year='2024', period='6')
+macro.get_maximum_theoretical_margin(asset='PETR4', report_date='2024-12-31')
+macro.get_dpmfi(start_date='2024-01', end_date='2024-12', status='dados_oficiais')
+macro.get_dpmfi_composition(bond_type='IPCA')
+```
+
 ### Reference Data
 
 #### Corporate Events

{btgsolutions_dataservices_python_client-3.2.12 → btgsolutions_dataservices_python_client-4.0.0}/README.md

@@ -360,9 +360,23 @@ bulk_data.get_compressed_data(channel='98', date='2026-01-30', data_type='instru
 
 ```python
 import btgsolutions_dataservices as btg
-ws = btg.HFNWebSocketClient(api_key='YOUR_API_KEY', country='brazil')
+ws = btg.HFNWebSocketClient(api_key='YOUR_API_KEY')
 ws.run(on_message=lambda message: print(message))
 
+# Subscribe to live economy news in Portuguese
+ws.subscribe(settings={'feed': 'economy', 'text_language': 'portuguese'})
+
+# Request latest news on demand (without subscribing to the live stream)
+ws.latest_news(settings={'feed': 'crypto', 'limit': '10'})
+
+# Get available filter values
+ws.available_filters(settings={})
+
+# Stop receiving broadcasts (keeps connection open)
+ws.unsubscribe()
+
+ws.close()
+
 ## The following is optional to keep the program running in a .py file:
 # from time import sleep
 # while True:
@@ -374,7 +388,22 @@ ws.run(on_message=lambda message: print(message))
 ```python
 import btgsolutions_dataservices as btg
 hfn = btg.HighFrequencyNews(api_key='YOUR_API_KEY')
-hfn.latest_news()
+
+# Latest news with filters
+hfn.get_latest_news(feed='economy', text_language='portuguese', limit=10)
+
+# Latest news by ticker tags
+hfn.get_latest_news(tags=['PETR4', 'VALE3'])
+
+# Historical news for a date range
+hfn.get_historical_news(
+    start_date='2026-05-01T00:00:00.000Z',
+    end_date='2026-05-08T23:59:59.999Z',
+    feed='economy',
+)
+
+# Available filter values
+hfn.get_available_filters()
 ```
 
 #### OPA
@@ -469,6 +498,98 @@ company_data = btg.CompanyData(api_key='YOUR_API_KEY')
 company_data.all_financial_tables(ticker='PETR4')
 ```
 
+#### Alternative Data - Metadata
+
+```python
+import btgsolutions_dataservices as btg
+meta = btg.AlternativeDataMetadata(api_key='YOUR_API_KEY')
+meta.get_company_directory(query='PETROBRAS', jurisdiction='BR')
+meta.get_company_sector(identifier='PETR4')
+meta.get_taxonomy(system='b3')
+meta.get_cnae(code='6422100')
+meta.get_sector_companies(sector='Petróleo, Gás e Biocombustíveis')
+meta.get_sectors_summary()
+meta.get_financial_statement_types()
+meta.get_datasets()
+meta.get_available_assets(dataset='maximum_theoretical_margin', prefix='PETR')
+meta.get_available_indicators()
+```
+
+#### Alternative Data - Companies
+
+```python
+import btgsolutions_dataservices as btg
+companies = btg.AlternativeDataCompanies(api_key='YOUR_API_KEY')
+companies.get_board(company_id='VALE3', body='board')
+companies.get_governance_summary(company_id='ITUB4')
+companies.get_governance_history(company_id='PETR4', start_date='2023-01-01', end_date='2024-12-31')
+companies.get_governance_documents(company_id='PETR4', start_date='2024-01-01', end_date='2024-12-31')
+companies.get_governance_compensation(company_id='VALE3', fiscal_year='2024')
+companies.get_governance_related_party(company_id='ITUB4')
+companies.get_governance_beneficial_ownership(company_id='VALE3')
+companies.get_corporate_registry(company_id='PETR4', direction='partners')
+companies.get_corporate_registry(company_id='PETR4', direction='investees')
+companies.get_insider_trades(company_id='AAPL', start_date='2024-01-01', end_date='2024-12-31')
+companies.get_board_changes(company_id='VALE3', event='appointed')
+companies.get_financial_statements(company_id='PETR4', statement='income_statement', quarter='Q42024')
+companies.get_financial_notes(company_id='VALE3', quarter='Q42024')
+companies.get_disclosures(company_id='PETR4', document_type='repurchase')
+companies.get_disclosures(company_id='PETR4', document_type='insider')
+```
+
+#### Alternative Data - People
+
+```python
+import btgsolutions_dataservices as btg
+people = btg.AlternativeDataPeople(api_key='YOUR_API_KEY')
+people.get_appointments(person_id='slug:Jean Paul Lemann', active_only=True)
+people.get_appointments(person_id='slug:Jean Paul Lemann', group_by='company')
+```
+
+#### Alternative Data - Funds
+
+```python
+import btgsolutions_dataservices as btg
+funds = btg.AlternativeDataFunds(api_key='YOUR_API_KEY')
+funds.get_holdings(fund_id='73.232.530/0001-46', reference_date='2024-12-31')
+funds.get_exposures(fund_id='73.232.530/0001-46', exposure_type='asset_class')
+funds.get_history(fund_id='73.232.530/0001-46', start_date='2024-01-01', end_date='2024-12-31')
+funds.get_lookthrough(fund_id='73.232.530/0001-46')
+funds.get_manager_aggregate_holdings(manager_id='ITAÚ ASSET MANAGEMENT')
+```
+
+#### Alternative Data - Ownership
+
+```python
+import btgsolutions_dataservices as btg
+ownership = btg.AlternativeDataOwnership(api_key='YOUR_API_KEY')
+ownership.get_top_shareholders(company_id='VALE3', limit=10)
+ownership.get_ownership_current(company_id='ITUB4')
+ownership.get_ownership_history(company_id='PETR4', start_date='2023-01-01', end_date='2024-12-31')
+ownership.get_ownership_change_events(company_id='VALE3', start_date='2024-01-01', end_date='2024-12-31')
+ownership.get_ownership_official_notices(company_id='PETR4')
+ownership.get_ownership_control_group(company_id='VALE3')
+ownership.get_ownership_free_float(company_id='PETR4')
+ownership.get_shareholder_holdings(shareholder_id='00.000.000/0001-91')
+ownership.get_institutional_holders(identifier='VALE3')
+ownership.get_fund_holders(identifier='PETR4', identifier_type='b3_ticker')
+```
+
+#### Alternative Data - Macro & Markets
+
+```python
+import btgsolutions_dataservices as btg
+macro = btg.AlternativeDataMacroMarkets(api_key='YOUR_API_KEY')
+macro.get_macro_indicators(indicator='selic')
+macro.get_macro_indicators(indicator='ipca_contributions', start_date='2024-01', end_date='2024-12')
+macro.get_macro_indicators(indicator='gdp', type='yoy')
+macro.get_macro_indicators(indicator='comexstat', year='2024', state='SP')
+macro.get_macro_indicators(indicator='rreo', year='2024', period='6')
+macro.get_maximum_theoretical_margin(asset='PETR4', report_date='2024-12-31')
+macro.get_dpmfi(start_date='2024-01', end_date='2024-12', status='dados_oficiais')
+macro.get_dpmfi_composition(bond_type='IPCA')
+```
+
 ### Reference Data
 
 #### Corporate Events

{btgsolutions_dataservices_python_client-3.2.12 → btgsolutions_dataservices_python_client-4.0.0}/btgsolutions_dataservices/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.2.12" 
+__version__ = "4.0.0"
 
 from .websocket import *
 from .rest import *

{btgsolutions_dataservices_python_client-3.2.12 → btgsolutions_dataservices_python_client-4.0.0}/btgsolutions_dataservices/config.py

@@ -137,6 +137,8 @@ hfn_socket_urls = {
     },
 }
 
+hfn_v3_socket_url = f'{url_ws}v3/hfn'
+
 broker_analytics_socket_urls = {
     BR: {
         REALTIME: f'{base_url_ws}{ws_br_b3_base_path}broker-analytics',

{btgsolutions_dataservices_python_client-3.2.12 → btgsolutions_dataservices_python_client-4.0.0}/btgsolutions_dataservices/rest/__init__.py

@@ -16,3 +16,9 @@ from .ticker_last_event_polling import TickerLastEventPolling
 from .broker_reference import BrokerReference
 from .book_scope import BookScope
 from .broker_analytics import BrokerAnalytics
+from .alternative_data_metadata import AlternativeDataMetadata
+from .alternative_data_companies import AlternativeDataCompanies
+from .alternative_data_people import AlternativeDataPeople
+from .alternative_data_funds import AlternativeDataFunds
+from .alternative_data_ownership import AlternativeDataOwnership
+from .alternative_data_macro_markets import AlternativeDataMacroMarkets