snaptrade-python-sdk 11.0.122__tar.gz → 11.0.123__tar.gz

snaptrade_python_sdk-11.0.122/README.md → snaptrade_python_sdk-11.0.123/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.1
+Name: snaptrade-python-sdk
+Version: 11.0.123
+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.122-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.122)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.123-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.123)
 [![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/)
 
@@ -26,6 +49,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.account_information.get_all_user_holdings`](#snaptradeaccount_informationget_all_user_holdings)
   * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
   * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
+  * [`snaptrade.account_information.get_user_account_order_detail`](#snaptradeaccount_informationget_user_account_order_detail)
   * [`snaptrade.account_information.get_user_account_orders`](#snaptradeaccount_informationget_user_account_orders)
   * [`snaptrade.account_information.get_user_account_positions`](#snaptradeaccount_informationget_user_account_positions)
   * [`snaptrade.account_information.get_user_account_recent_orders`](#snaptradeaccount_informationget_user_account_recent_orders)
@@ -88,7 +112,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.122
+pip install snaptrade-python-sdk==11.0.123
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -378,6 +402,46 @@ get_user_account_details_response = (
 
 ---
 
+### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
+
+Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_order_detail_response = (
+    snaptrade.account_information.get_user_account_order_detail(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/{brokerageOrderId}` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.account_information.get_user_account_orders`<a id="snaptradeaccount_informationget_user_account_orders"></a>
 
 Returns a list of recent orders in the specified account.
@@ -2616,3 +2680,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.122/PKG-INFO → snaptrade_python_sdk-11.0.123/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: snaptrade-python-sdk
-Version: 11.0.122
-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.122-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.122)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.123-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.123)
 [![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/)
 
@@ -49,6 +26,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.account_information.get_all_user_holdings`](#snaptradeaccount_informationget_all_user_holdings)
   * [`snaptrade.account_information.get_user_account_balance`](#snaptradeaccount_informationget_user_account_balance)
   * [`snaptrade.account_information.get_user_account_details`](#snaptradeaccount_informationget_user_account_details)
+  * [`snaptrade.account_information.get_user_account_order_detail`](#snaptradeaccount_informationget_user_account_order_detail)
   * [`snaptrade.account_information.get_user_account_orders`](#snaptradeaccount_informationget_user_account_orders)
   * [`snaptrade.account_information.get_user_account_positions`](#snaptradeaccount_informationget_user_account_positions)
   * [`snaptrade.account_information.get_user_account_recent_orders`](#snaptradeaccount_informationget_user_account_recent_orders)
@@ -111,7 +89,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.122
+pip install snaptrade-python-sdk==11.0.123
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -401,6 +379,46 @@ get_user_account_details_response = (
 
 ---
 
+### `snaptrade.account_information.get_user_account_order_detail`<a id="snaptradeaccount_informationget_user_account_order_detail"></a>
+
+Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_order_detail_response = (
+    snaptrade.account_information.get_user_account_order_detail(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        brokerage_order_id="66a033fa-da74-4fcf-b527-feefdec9257e",
+    )
+)
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### user_id: `str`<a id="user_id-str"></a>
+
+##### user_secret: `str`<a id="user_secret-str"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### brokerage_order_id: `str`<a id="brokerage_order_id-str"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrderRecord`](./snaptrade_client/type/account_order_record.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/{brokerageOrderId}` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.account_information.get_user_account_orders`<a id="snaptradeaccount_informationget_user_account_orders"></a>
 
 Returns a list of recent orders in the specified account.
@@ -2639,4 +2657,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.122 → snaptrade_python_sdk-11.0.123}/pyproject.toml

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

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/__init__.py

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

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

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/apis/path_to_api.py

@@ -20,6 +20,7 @@ from snaptrade_client.apis.paths.accounts_account_id import AccountsAccountId
 from snaptrade_client.apis.paths.accounts_account_id_balances import AccountsAccountIdBalances
 from snaptrade_client.apis.paths.accounts_account_id_positions import AccountsAccountIdPositions
 from snaptrade_client.apis.paths.accounts_account_id_orders import AccountsAccountIdOrders
+from snaptrade_client.apis.paths.accounts_account_id_orders_brokerage_order_id import AccountsAccountIdOrdersBrokerageOrderId
 from snaptrade_client.apis.paths.accounts_account_id_recent_orders import AccountsAccountIdRecentOrders
 from snaptrade_client.apis.paths.accounts_account_id_return_rates import AccountsAccountIdReturnRates
 from snaptrade_client.apis.paths.accounts_account_id_activities import AccountsAccountIdActivities
@@ -78,6 +79,7 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.ACCOUNTS_ACCOUNT_ID_BALANCES: AccountsAccountIdBalances,
         PathValues.ACCOUNTS_ACCOUNT_ID_POSITIONS: AccountsAccountIdPositions,
         PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS: AccountsAccountIdOrders,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID: AccountsAccountIdOrdersBrokerageOrderId,
         PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS: AccountsAccountIdRecentOrders,
         PathValues.ACCOUNTS_ACCOUNT_ID_RETURN_RATES: AccountsAccountIdReturnRates,
         PathValues.ACCOUNTS_ACCOUNT_ID_ACTIVITIES: AccountsAccountIdActivities,
@@ -137,6 +139,7 @@ path_to_api = PathToApi(
         PathValues.ACCOUNTS_ACCOUNT_ID_BALANCES: AccountsAccountIdBalances,
         PathValues.ACCOUNTS_ACCOUNT_ID_POSITIONS: AccountsAccountIdPositions,
         PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS: AccountsAccountIdOrders,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID: AccountsAccountIdOrdersBrokerageOrderId,
         PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS: AccountsAccountIdRecentOrders,
         PathValues.ACCOUNTS_ACCOUNT_ID_RETURN_RATES: AccountsAccountIdReturnRates,
         PathValues.ACCOUNTS_ACCOUNT_ID_ACTIVITIES: AccountsAccountIdActivities,

snaptrade_python_sdk-11.0.123/snaptrade_client/apis/paths/accounts_account_id_orders_brokerage_order_id.py

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

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/apis/tags/account_information_api_generated.py

@@ -13,6 +13,7 @@ from snaptrade_client.paths.accounts_account_id_activities.get import GetAccount
 from snaptrade_client.paths.holdings.get import GetAllUserHoldings
 from snaptrade_client.paths.accounts_account_id_balances.get import GetUserAccountBalance
 from snaptrade_client.paths.accounts_account_id.get import GetUserAccountDetails
+from snaptrade_client.paths.accounts_account_id_orders_brokerage_order_id.get import GetUserAccountOrderDetail
 from snaptrade_client.paths.accounts_account_id_orders.get import GetUserAccountOrders
 from snaptrade_client.paths.accounts_account_id_positions.get import GetUserAccountPositions
 from snaptrade_client.paths.accounts_account_id_recent_orders.get import GetUserAccountRecentOrders
@@ -27,6 +28,7 @@ class AccountInformationApiGenerated(
     GetAllUserHoldings,
     GetUserAccountBalance,
     GetUserAccountDetails,
+    GetUserAccountOrderDetail,
     GetUserAccountOrders,
     GetUserAccountPositions,
     GetUserAccountRecentOrders,

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

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/model/account.py

@@ -132,6 +132,7 @@ class Account(
                         "open": "OPEN",
                         "closed": "CLOSED",
                         "archived": "ARCHIVED",
+                        "unavailable": "UNAVAILABLE",
                     }
                 
                 @schemas.classproperty
@@ -145,6 +146,10 @@ class Account(
                 @schemas.classproperty
                 def ARCHIVED(cls):
                     return cls("archived")
+                
+                @schemas.classproperty
+                def UNAVAILABLE(cls):
+                    return cls("unavailable")
             
             
                 def __new__(

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/model/account.pyi

@@ -132,6 +132,7 @@ class Account(
                         "open": "OPEN",
                         "closed": "CLOSED",
                         "archived": "ARCHIVED",
+                        "unavailable": "UNAVAILABLE",
                     }
                 
                 @schemas.classproperty
@@ -145,6 +146,10 @@ class Account(
                 @schemas.classproperty
                 def ARCHIVED(cls):
                     return cls("archived")
+                
+                @schemas.classproperty
+                def UNAVAILABLE(cls):
+                    return cls("unavailable")
             
             
                 def __new__(

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/operation_parameter_map.py

@@ -66,6 +66,22 @@ operation_parameter_map = {
             },
         ]
     },
+    '/accounts/{accountId}/orders/{brokerageOrderId}-GET': {
+        'parameters': [
+            {
+                'name': 'userId'
+            },
+            {
+                'name': 'userSecret'
+            },
+            {
+                'name': 'accountId'
+            },
+            {
+                'name': 'brokerageOrderId'
+            },
+        ]
+    },
     '/accounts/{accountId}/orders-GET': {
         'parameters': [
             {

{snaptrade_python_sdk-11.0.122 → snaptrade_python_sdk-11.0.123}/snaptrade_client/paths/__init__.py

@@ -25,6 +25,7 @@ class PathValues(str, enum.Enum):
     ACCOUNTS_ACCOUNT_ID_BALANCES = "/accounts/{accountId}/balances"
     ACCOUNTS_ACCOUNT_ID_POSITIONS = "/accounts/{accountId}/positions"
     ACCOUNTS_ACCOUNT_ID_ORDERS = "/accounts/{accountId}/orders"
+    ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID = "/accounts/{accountId}/orders/{brokerageOrderId}"
     ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS = "/accounts/{accountId}/recentOrders"
     ACCOUNTS_ACCOUNT_ID_RETURN_RATES = "/accounts/{accountId}/returnRates"
     ACCOUNTS_ACCOUNT_ID_ACTIVITIES = "/accounts/{accountId}/activities"

snaptrade_python_sdk-11.0.123/snaptrade_client/paths/accounts_account_id_orders_brokerage_order_id/__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_brokerage_order_id import Api
+
+from snaptrade_client.paths import PathValues
+
+path = PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_BROKERAGE_ORDER_ID