snaptrade-python-sdk 11.0.116__tar.gz → 11.0.117__tar.gz

snaptrade_python_sdk-11.0.116/README.md → snaptrade_python_sdk-11.0.117/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.1
+Name: snaptrade-python-sdk
+Version: 11.0.117
+Summary: Client for SnapTrade
+License: MIT
+Author: SnapTrade
+Author-email: api@snaptrade.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: aiohttp (>=3.10.11,<4.0.0)
+Requires-Dist: certifi (>=2023.7.22)
+Requires-Dist: cryptography (>=43.0.3,<44.0.0)
+Requires-Dist: frozendict (>=2.3.4,<3.0.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: typing_extensions (==4.13.2)
+Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
+Description-Content-Type: text/markdown
+
 <div align="center">
 
 [![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
@@ -7,7 +30,7 @@
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.116-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.116)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.117-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.117)
 [![README.md](https://img.shields.io/badge/README-Click%20Here-green)](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/python#readme)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
@@ -58,6 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
   * [`snaptrade.reference_data.get_symbols_by_ticker`](#snaptradereference_dataget_symbols_by_ticker)
   * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
+  * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
   * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
   * [`snaptrade.reference_data.list_all_currencies`](#snaptradereference_datalist_all_currencies)
   * [`snaptrade.reference_data.list_all_currencies_rates`](#snaptradereference_datalist_all_currencies_rates)
@@ -87,7 +111,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.116
+pip install snaptrade-python-sdk==11.0.117
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1542,6 +1566,36 @@ Comma separated value of brokerage slugs
 
 ---
 
+### `snaptrade.reference_data.list_all_brokerage_instruments`<a id="snaptradereference_datalist_all_brokerage_instruments"></a>
+
+Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_all_brokerage_instruments_response = (
+    snaptrade.reference_data.list_all_brokerage_instruments(
+        brokerage_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_id: `str`<a id="brokerage_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageInstrumentsResponse`](./snaptrade_client/type/brokerage_instruments_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerages/{brokerageId}/instruments` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
 
 Returns a list of all defined Brokerage objects.
@@ -2583,3 +2637,4 @@ Optional frequency for the rate of return chart (defaults to monthly). Possible
 
 ## Author<a id="author"></a>
 This Python package is automatically generated by [Konfig](https://konfigthis.com)
+

snaptrade_python_sdk-11.0.116/PKG-INFO → snaptrade_python_sdk-11.0.117/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: snaptrade-python-sdk
-Version: 11.0.116
-Summary: Client for SnapTrade
-License: MIT
-Author: SnapTrade
-Author-email: api@snaptrade.com
-Requires-Python: >=3.8,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: aiohttp (>=3.10.11,<4.0.0)
-Requires-Dist: certifi (>=2023.7.22)
-Requires-Dist: cryptography (>=43.0.3,<44.0.0)
-Requires-Dist: frozendict (>=2.3.4,<3.0.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
-Requires-Dist: typing_extensions (==4.13.2)
-Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
-Description-Content-Type: text/markdown
-
 <div align="center">
 
 [![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
@@ -30,7 +7,7 @@ Description-Content-Type: text/markdown
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.116-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.116)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.117-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.117)
 [![README.md](https://img.shields.io/badge/README-Click%20Here-green)](https://github.com/passiv/snaptrade-sdks/tree/master/sdks/python#readme)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
@@ -81,6 +58,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
   * [`snaptrade.reference_data.get_symbols_by_ticker`](#snaptradereference_dataget_symbols_by_ticker)
   * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
+  * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
   * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
   * [`snaptrade.reference_data.list_all_currencies`](#snaptradereference_datalist_all_currencies)
   * [`snaptrade.reference_data.list_all_currencies_rates`](#snaptradereference_datalist_all_currencies_rates)
@@ -110,7 +88,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.116
+pip install snaptrade-python-sdk==11.0.117
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1565,6 +1543,36 @@ Comma separated value of brokerage slugs
 
 ---
 
+### `snaptrade.reference_data.list_all_brokerage_instruments`<a id="snaptradereference_datalist_all_brokerage_instruments"></a>
+
+Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+list_all_brokerage_instruments_response = (
+    snaptrade.reference_data.list_all_brokerage_instruments(
+        brokerage_id="87b24961-b51e-4db8-9226-f198f6518a89",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_id: `str`<a id="brokerage_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`BrokerageInstrumentsResponse`](./snaptrade_client/type/brokerage_instruments_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/brokerages/{brokerageId}/instruments` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.reference_data.list_all_brokerages`<a id="snaptradereference_datalist_all_brokerages"></a>
 
 Returns a list of all defined Brokerage objects.
@@ -2606,4 +2614,3 @@ Optional frequency for the rate of return chart (defaults to monthly). Possible
 
 ## Author<a id="author"></a>
 This Python package is automatically generated by [Konfig](https://konfigthis.com)
-

{snaptrade_python_sdk-11.0.116 → snaptrade_python_sdk-11.0.117}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snaptrade-python-sdk"
-version = "11.0.116"
+version = "11.0.117"
 description = "Client for SnapTrade"
 authors = ["SnapTrade <api@snaptrade.com>"]
 license = "MIT"

{snaptrade_python_sdk-11.0.116 → snaptrade_python_sdk-11.0.117}/snaptrade_client/__init__.py

@@ -12,7 +12,7 @@
     Created by: https://snaptrade.com/
 """
 
-__version__ = "11.0.116"
+__version__ = "11.0.117"
 
 # import ApiClient
 from snaptrade_client.api_client import ApiClient

{snaptrade_python_sdk-11.0.116 → snaptrade_python_sdk-11.0.117}/snaptrade_client/api_client.py

@@ -1155,7 +1155,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Konfig/11.0.116/python'
+        self.user_agent = 'Konfig/11.0.117/python'
 
     def __enter__(self):
         return self

{snaptrade_python_sdk-11.0.116 → snaptrade_python_sdk-11.0.117}/snaptrade_client/apis/path_to_api.py

@@ -46,6 +46,7 @@ from snaptrade_client.apis.paths.accounts_account_id_trading_cancel import Accou
 from snaptrade_client.apis.paths.snap_trade_partners import SnapTradePartners
 from snaptrade_client.apis.paths.accounts_account_id_symbols import AccountsAccountIdSymbols
 from snaptrade_client.apis.paths.brokerages import Brokerages
+from snaptrade_client.apis.paths.brokerages_brokerage_id_instruments import BrokeragesBrokerageIdInstruments
 from snaptrade_client.apis.paths.brokerage_authorization_types import BrokerageAuthorizationTypes
 from snaptrade_client.apis.paths.currencies import Currencies
 from snaptrade_client.apis.paths.currencies_rates import CurrenciesRates
@@ -103,6 +104,7 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.SNAP_TRADE_PARTNERS: SnapTradePartners,
         PathValues.ACCOUNTS_ACCOUNT_ID_SYMBOLS: AccountsAccountIdSymbols,
         PathValues.BROKERAGES: Brokerages,
+        PathValues.BROKERAGES_BROKERAGE_ID_INSTRUMENTS: BrokeragesBrokerageIdInstruments,
         PathValues.BROKERAGE_AUTHORIZATION_TYPES: BrokerageAuthorizationTypes,
         PathValues.CURRENCIES: Currencies,
         PathValues.CURRENCIES_RATES: CurrenciesRates,
@@ -161,6 +163,7 @@ path_to_api = PathToApi(
         PathValues.SNAP_TRADE_PARTNERS: SnapTradePartners,
         PathValues.ACCOUNTS_ACCOUNT_ID_SYMBOLS: AccountsAccountIdSymbols,
         PathValues.BROKERAGES: Brokerages,
+        PathValues.BROKERAGES_BROKERAGE_ID_INSTRUMENTS: BrokeragesBrokerageIdInstruments,
         PathValues.BROKERAGE_AUTHORIZATION_TYPES: BrokerageAuthorizationTypes,
         PathValues.CURRENCIES: Currencies,
         PathValues.CURRENCIES_RATES: CurrenciesRates,

snaptrade_python_sdk-11.0.117/snaptrade_client/apis/paths/brokerages_brokerage_id_instruments.py

@@ -0,0 +1,7 @@
+from snaptrade_client.paths.brokerages_brokerage_id_instruments.get import ApiForget
+
+
+class BrokeragesBrokerageIdInstruments(
+    ApiForget,
+):
+    pass

{snaptrade_python_sdk-11.0.116 → snaptrade_python_sdk-11.0.117}/snaptrade_client/apis/tags/reference_data_api_generated.py

@@ -16,6 +16,7 @@ from snaptrade_client.paths.exchanges.get import GetStockExchanges
 from snaptrade_client.paths.symbols.post import GetSymbols
 from snaptrade_client.paths.symbols_query.get import GetSymbolsByTicker
 from snaptrade_client.paths.brokerage_authorization_types.get import ListAllBrokerageAuthorizationType
+from snaptrade_client.paths.brokerages_brokerage_id_instruments.get import ListAllBrokerageInstruments
 from snaptrade_client.paths.brokerages.get import ListAllBrokerages
 from snaptrade_client.paths.currencies.get import ListAllCurrencies
 from snaptrade_client.paths.currencies_rates.get import ListAllCurrenciesRates
@@ -30,6 +31,7 @@ class ReferenceDataApiGenerated(
     GetSymbols,
     GetSymbolsByTicker,
     ListAllBrokerageAuthorizationType,
+    ListAllBrokerageInstruments,
     ListAllBrokerages,
     ListAllCurrencies,
     ListAllCurrenciesRates,

{snaptrade_python_sdk-11.0.116 → snaptrade_python_sdk-11.0.117}/snaptrade_client/configuration.py

@@ -438,7 +438,7 @@ conf = snaptrade_client.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 11.0.116".\
+               "SDK Package Version: 11.0.117".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

snaptrade_python_sdk-11.0.117/snaptrade_client/model/brokerage_id.py

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+BrokerageID = schemas.UUIDSchema

snaptrade_python_sdk-11.0.117/snaptrade_client/model/brokerage_id.pyi

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+BrokerageID = schemas.UUIDSchema

snaptrade_python_sdk-11.0.117/snaptrade_client/model/brokerage_instrument.py

@@ -0,0 +1,197 @@
+# coding: utf-8
+
+"""
+    SnapTrade
+
+    Connect brokerage accounts to your app for live positions and trading
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: api@snaptrade.com
+    Created by: https://snaptrade.com/
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from snaptrade_client import schemas  # noqa: F401
+
+
+class BrokerageInstrument(
+    schemas.DictSchema
+):
+    """
+    This class is auto generated by Konfig (https://konfigthis.com)
+    """
+
+
+    class MetaOapg:
+        
+        class properties:
+            symbol = schemas.StrSchema
+            
+            
+            class exchange_mic(
+                schemas.StrBase,
+                schemas.NoneBase,
+                schemas.Schema,
+                schemas.NoneStrMixin
+            ):
+            
+            
+                def __new__(
+                    cls,
+                    *args: typing.Union[None, str, ],
+                    _configuration: typing.Optional[schemas.Configuration] = None,
+                ) -> 'exchange_mic':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                    )
+            
+            
+            class tradeable(
+                schemas.BoolBase,
+                schemas.NoneBase,
+                schemas.Schema,
+                schemas.NoneBoolMixin
+            ):
+            
+            
+                def __new__(
+                    cls,
+                    *args: typing.Union[None, bool, ],
+                    _configuration: typing.Optional[schemas.Configuration] = None,
+                ) -> 'tradeable':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                    )
+            
+            
+            class fractionable(
+                schemas.BoolBase,
+                schemas.NoneBase,
+                schemas.Schema,
+                schemas.NoneBoolMixin
+            ):
+            
+            
+                def __new__(
+                    cls,
+                    *args: typing.Union[None, bool, ],
+                    _configuration: typing.Optional[schemas.Configuration] = None,
+                ) -> 'fractionable':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                    )
+            
+            
+            class universal_symbol_id(
+                schemas.UUIDBase,
+                schemas.StrBase,
+                schemas.NoneBase,
+                schemas.Schema,
+                schemas.NoneStrMixin
+            ):
+            
+            
+                class MetaOapg:
+                    format = 'uuid'
+            
+            
+                def __new__(
+                    cls,
+                    *args: typing.Union[None, str, uuid.UUID, ],
+                    _configuration: typing.Optional[schemas.Configuration] = None,
+                ) -> 'universal_symbol_id':
+                    return super().__new__(
+                        cls,
+                        *args,
+                        _configuration=_configuration,
+                    )
+            __annotations__ = {
+                "symbol": symbol,
+                "exchange_mic": exchange_mic,
+                "tradeable": tradeable,
+                "fractionable": fractionable,
+                "universal_symbol_id": universal_symbol_id,
+            }
+        additional_properties = schemas.AnyTypeSchema
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["symbol"]) -> MetaOapg.properties.symbol: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["exchange_mic"]) -> MetaOapg.properties.exchange_mic: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["tradeable"]) -> MetaOapg.properties.tradeable: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["fractionable"]) -> MetaOapg.properties.fractionable: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["universal_symbol_id"]) -> MetaOapg.properties.universal_symbol_id: ...
+    
+    @typing.overload
+    def __getitem__(self, name: str) -> MetaOapg.additional_properties: ...
+    
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["exchange_mic"], typing_extensions.Literal["tradeable"], typing_extensions.Literal["fractionable"], typing_extensions.Literal["universal_symbol_id"], str, ]):
+        # dict_instance[name] accessor
+        return super().__getitem__(name)
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["symbol"]) -> typing.Union[MetaOapg.properties.symbol, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["exchange_mic"]) -> typing.Union[MetaOapg.properties.exchange_mic, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["tradeable"]) -> typing.Union[MetaOapg.properties.tradeable, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["fractionable"]) -> typing.Union[MetaOapg.properties.fractionable, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["universal_symbol_id"]) -> typing.Union[MetaOapg.properties.universal_symbol_id, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: str) -> typing.Union[MetaOapg.additional_properties, schemas.Unset]: ...
+    
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["symbol"], typing_extensions.Literal["exchange_mic"], typing_extensions.Literal["tradeable"], typing_extensions.Literal["fractionable"], typing_extensions.Literal["universal_symbol_id"], str, ]):
+        return super().get_item_oapg(name)
+
+    def __new__(
+        cls,
+        *args: typing.Union[dict, frozendict.frozendict, ],
+        symbol: typing.Union[MetaOapg.properties.symbol, str, schemas.Unset] = schemas.unset,
+        exchange_mic: typing.Union[MetaOapg.properties.exchange_mic, None, str, schemas.Unset] = schemas.unset,
+        tradeable: typing.Union[MetaOapg.properties.tradeable, None, bool, schemas.Unset] = schemas.unset,
+        fractionable: typing.Union[MetaOapg.properties.fractionable, None, bool, schemas.Unset] = schemas.unset,
+        universal_symbol_id: typing.Union[MetaOapg.properties.universal_symbol_id, None, str, uuid.UUID, schemas.Unset] = schemas.unset,
+        _configuration: typing.Optional[schemas.Configuration] = None,
+        **kwargs: typing.Union[MetaOapg.additional_properties, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, ],
+    ) -> 'BrokerageInstrument':
+        return super().__new__(
+            cls,
+            *args,
+            symbol=symbol,
+            exchange_mic=exchange_mic,
+            tradeable=tradeable,
+            fractionable=fractionable,
+            universal_symbol_id=universal_symbol_id,
+            _configuration=_configuration,
+            **kwargs,
+        )