snaptrade-python-sdk 11.0.157__tar.gz → 11.0.158__tar.gz

snaptrade_python_sdk-11.0.157/README.md → snaptrade_python_sdk-11.0.158/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.1
+Name: snaptrade-python-sdk
+Version: 11.0.158
+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.157-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.157)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.158-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.158)
 [![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/)
 
@@ -47,6 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
+  * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
   * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
@@ -88,7 +112,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.157
+pip install snaptrade-python-sdk==11.0.158
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1204,6 +1228,58 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
+### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
+
+Returns the detail of a single order using the external order ID provided in the request body.
+
+The V2 order response format includes all legs of the order in the `legs` list field.
+If the order is single legged, `legs` will be a list of one leg.
+
+This endpoint is always realtime and does not rely on cached data.
+
+This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_order_detail_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
+        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecordV2`](./snaptrade_client/type/account_order_record_v2.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/details/v2` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.experimental_endpoints.get_user_account_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_orders_v2"></a>
 
 Returns a list of recent orders in the specified account.
@@ -2656,3 +2732,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.157/PKG-INFO → snaptrade_python_sdk-11.0.158/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: snaptrade-python-sdk
-Version: 11.0.157
-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.157-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.157)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.158-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.158)
 [![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/)
 
@@ -70,6 +47,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.remove_brokerage_authorization`](#snaptradeconnectionsremove_brokerage_authorization)
   * [`snaptrade.connections.return_rates`](#snaptradeconnectionsreturn_rates)
   * [`snaptrade.connections.session_events`](#snaptradeconnectionssession_events)
+  * [`snaptrade.experimental_endpoints.get_user_account_order_detail_v2`](#snaptradeexperimental_endpointsget_user_account_order_detail_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_orders_v2`](#snaptradeexperimental_endpointsget_user_account_orders_v2)
   * [`snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`](#snaptradeexperimental_endpointsget_user_account_recent_orders_v2)
   * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
@@ -111,7 +89,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.157
+pip install snaptrade-python-sdk==11.0.158
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1227,6 +1205,58 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
+### `snaptrade.experimental_endpoints.get_user_account_order_detail_v2`<a id="snaptradeexperimental_endpointsget_user_account_order_detail_v2"></a>
+
+Returns the detail of a single order using the external order ID provided in the request body.
+
+The V2 order response format includes all legs of the order in the `legs` list field.
+If the order is single legged, `legs` will be a list of one leg.
+
+This endpoint is always realtime and does not rely on cached data.
+
+This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_order_detail_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_order_detail_v2(
+        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+#### ⚙️ Request Body<a id="⚙️-request-body"></a>
+
+[`Any`](./snaptrade_client/type/typing_any.py)
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecordV2`](./snaptrade_client/type/account_order_record_v2.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/details/v2` `post`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.experimental_endpoints.get_user_account_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_orders_v2"></a>
 
 Returns a list of recent orders in the specified account.
@@ -2679,4 +2709,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.157 → snaptrade_python_sdk-11.0.158}/pyproject.toml

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

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/snaptrade_client/__init__.py

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

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/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.157/python'
+        self.user_agent = 'Konfig/11.0.158/python'
 
     def __enter__(self):
         return self

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/snaptrade_client/apis/path_to_api.py

@@ -55,6 +55,7 @@ from snaptrade_client.apis.paths.exchanges import Exchanges
 from snaptrade_client.apis.paths.security_types import SecurityTypes
 from snaptrade_client.apis.paths.symbols import Symbols
 from snaptrade_client.apis.paths.symbols_query import SymbolsQuery
+from snaptrade_client.apis.paths.accounts_account_id_orders_details_v2 import AccountsAccountIdOrdersDetailsV2
 
 PathToApi = typing_extensions.TypedDict(
     'PathToApi',
@@ -113,6 +114,7 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.SECURITY_TYPES: SecurityTypes,
         PathValues.SYMBOLS: Symbols,
         PathValues.SYMBOLS_QUERY: SymbolsQuery,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS_V2: AccountsAccountIdOrdersDetailsV2,
     }
 )
 
@@ -172,5 +174,6 @@ path_to_api = PathToApi(
         PathValues.SECURITY_TYPES: SecurityTypes,
         PathValues.SYMBOLS: Symbols,
         PathValues.SYMBOLS_QUERY: SymbolsQuery,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS_V2: AccountsAccountIdOrdersDetailsV2,
     }
 )

snaptrade_python_sdk-11.0.158/snaptrade_client/apis/paths/accounts_account_id_orders_details_v2.py

@@ -0,0 +1,7 @@
+from snaptrade_client.paths.accounts_account_id_orders_details_v2.post import ApiForpost
+
+
+class AccountsAccountIdOrdersDetailsV2(
+    ApiForpost,
+):
+    pass

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/snaptrade_client/apis/tags/experimental_endpoints_api_generated.py

@@ -9,11 +9,13 @@
     Created by: https://snaptrade.com/
 """
 
+from snaptrade_client.paths.accounts_account_id_orders_details_v2.post import GetUserAccountOrderDetailV2
 from snaptrade_client.paths.accounts_account_id_orders_v2.get import GetUserAccountOrdersV2
 from snaptrade_client.paths.accounts_account_id_recent_orders_v2.get import GetUserAccountRecentOrdersV2
 
 
 class ExperimentalEndpointsApiGenerated(
+    GetUserAccountOrderDetailV2,
     GetUserAccountOrdersV2,
     GetUserAccountRecentOrdersV2,
 ):

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/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.157".\
+               "SDK Package Version: 11.0.158".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/snaptrade_client/operation_parameter_map.py

@@ -333,6 +333,22 @@ operation_parameter_map = {
             },
         ]
     },
+    '/accounts/{accountId}/orders/details/v2-POST': {
+        'parameters': [
+            {
+                'name': 'brokerage_order_id'
+            },
+            {
+                'name': 'accountId'
+            },
+            {
+                'name': 'userId'
+            },
+            {
+                'name': 'userSecret'
+            },
+        ]
+    },
     '/accounts/{accountId}/orders/v2-GET': {
         'parameters': [
             {

{snaptrade_python_sdk-11.0.157 → snaptrade_python_sdk-11.0.158}/snaptrade_client/paths/__init__.py

@@ -60,3 +60,4 @@ class PathValues(str, enum.Enum):
     SECURITY_TYPES = "/securityTypes"
     SYMBOLS = "/symbols"
     SYMBOLS_QUERY = "/symbols/{query}"
+    ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS_V2 = "/accounts/{accountId}/orders/details/v2"

snaptrade_python_sdk-11.0.158/snaptrade_client/paths/accounts_account_id_orders_details_v2/__init__.py

@@ -0,0 +1,7 @@
+# do not import all endpoints into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all endpoints from this module, import them with
+# from snaptrade_client.paths.accounts_account_id_orders_details_v2 import Api
+
+from snaptrade_client.paths import PathValues
+
+path = PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_DETAILS_V2