snaptrade-python-sdk 13.0.46__tar.gz → 13.0.47__tar.gz

snaptrade_python_sdk-13.0.46/README.md → snaptrade_python_sdk-13.0.47/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.1
+Name: snaptrade-python-sdk
+Version: 13.0.47
+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)
+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,<5)
+Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
+Description-Content-Type: text/markdown
+
 <div align="left">
 
 [![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
@@ -64,7 +87,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
 
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v13.0.46-blue)](https://pypi.org/project/snaptrade-python-sdk/13.0.46)
+[![PyPI](https://img.shields.io/badge/PyPI-v13.0.47-blue)](https://pypi.org/project/snaptrade-python-sdk/13.0.47)
 [![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/)
 
@@ -114,6 +137,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
   * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
   * [`snaptrade.experimental_endpoints.add_subscription`](#snaptradeexperimental_endpointsadd_subscription)
   * [`snaptrade.experimental_endpoints.cancel_subscription`](#snaptradeexperimental_endpointscancel_subscription)
+  * [`snaptrade.experimental_endpoints.get_all_account_orders`](#snaptradeexperimental_endpointsget_all_account_orders)
   * [`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)
@@ -154,7 +178,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==13.0.46
+pip install snaptrade-python-sdk==13.0.47
 ```
 
 ## Authentication<a id="authentication"></a>
@@ -2148,6 +2172,80 @@ Unique identifier for the connected brokerage account. This is the UUID used to
 
 ---
 
+### `snaptrade.experimental_endpoints.get_all_account_orders`<a id="snaptradeexperimental_endpointsget_all_account_orders"></a>
+
+Returns a list of recent orders in the specified account, in the same `kind`-discriminated format as `/accounts/{accountId}/positions/all`.
+
+Every order carries a `legs` list with at least one leg. Each leg's `instrument` uses the same `Instrument` union as positions; switch on `instrument.kind` to know which fields are present. Multi-leg orders (spreads, strangles, covered calls) are a single order with multiple legs. Orders that belong to a complex order group (OCO, OTO, OTOCO) share a `group.id`.
+
+`order_type` is an object discriminated by `kind`. Each kind declares the price fields it requires (`limit_price` on `limit`, `stop_price` on `stop`, both on `stop_limit`, `trail` on `trailing_stop`), so a consumer never has to null-check a price that cannot exist for that kind. When the brokerage reports an order type we cannot normalize, `kind` is `other` and the brokerage's own label is in `raw_type`.
+
+**Experimental:** this endpoint may change without notice.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+##### Commercial API Key Auth<a id="commercial-api-key-auth"></a>
+
+```python
+get_all_account_orders_response = (
+    commercial_api_key_client.experimental_endpoints.get_all_account_orders(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+Required credentials for this mode:
+
+- `user_id` (str, required): SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
+
+- `user_secret` (str, required): SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
+
+##### Personal API Key Auth<a id="personal-api-key-auth"></a>
+
+```python
+get_all_account_orders_response = (
+    personal_api_key_client.experimental_endpoints.get_all_account_orders(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+    )
+)
+```
+
+The client identifies the user in this mode. Do not pass `user_id` `user_secret` to this method.
+
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### state: `str`<a id="state-str"></a>
+
+defaults to \"all\"
+
+##### days: `int`<a id="days-int"></a>
+
+Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AllAccountOrdersResponse`](./snaptrade_client/type/all_account_orders_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/all` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `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 brokerage order ID provided as a path parameter.
@@ -4216,3 +4314,4 @@ The client identifies the user in this mode. Do not pass `user_id` `user_secret`
 
 ## Author<a id="author"></a>
 This Python package is automatically generated by [Konfig](https://konfigthis.com)
+

snaptrade_python_sdk-13.0.46/PKG-INFO → snaptrade_python_sdk-13.0.47/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.1
-Name: snaptrade-python-sdk
-Version: 13.0.46
-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)
-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,<5)
-Requires-Dist: urllib3 (>=1.26.18,<3.0.0)
-Description-Content-Type: text/markdown
-
 <div align="left">
 
 [![Visit SnapTrade](https://raw.githubusercontent.com/passiv/snaptrade-sdks/HEAD/sdks/python/header.png)](https://snaptrade.com)
@@ -87,7 +64,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
 
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v13.0.46-blue)](https://pypi.org/project/snaptrade-python-sdk/13.0.46)
+[![PyPI](https://img.shields.io/badge/PyPI-v13.0.47-blue)](https://pypi.org/project/snaptrade-python-sdk/13.0.47)
 [![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/)
 
@@ -137,6 +114,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
   * [`snaptrade.connections.sync_brokerage_authorization_transactions`](#snaptradeconnectionssync_brokerage_authorization_transactions)
   * [`snaptrade.experimental_endpoints.add_subscription`](#snaptradeexperimental_endpointsadd_subscription)
   * [`snaptrade.experimental_endpoints.cancel_subscription`](#snaptradeexperimental_endpointscancel_subscription)
+  * [`snaptrade.experimental_endpoints.get_all_account_orders`](#snaptradeexperimental_endpointsget_all_account_orders)
   * [`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)
@@ -177,7 +155,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==13.0.46
+pip install snaptrade-python-sdk==13.0.47
 ```
 
 ## Authentication<a id="authentication"></a>
@@ -2171,6 +2149,80 @@ Unique identifier for the connected brokerage account. This is the UUID used to
 
 ---
 
+### `snaptrade.experimental_endpoints.get_all_account_orders`<a id="snaptradeexperimental_endpointsget_all_account_orders"></a>
+
+Returns a list of recent orders in the specified account, in the same `kind`-discriminated format as `/accounts/{accountId}/positions/all`.
+
+Every order carries a `legs` list with at least one leg. Each leg's `instrument` uses the same `Instrument` union as positions; switch on `instrument.kind` to know which fields are present. Multi-leg orders (spreads, strangles, covered calls) are a single order with multiple legs. Orders that belong to a complex order group (OCO, OTO, OTOCO) share a `group.id`.
+
+`order_type` is an object discriminated by `kind`. Each kind declares the price fields it requires (`limit_price` on `limit`, `stop_price` on `stop`, both on `stop_limit`, `trail` on `trailing_stop`), so a consumer never has to null-check a price that cannot exist for that kind. When the brokerage reports an order type we cannot normalize, `kind` is `other` and the brokerage's own label is in `raw_type`.
+
+**Experimental:** this endpoint may change without notice.
+
+If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+##### Commercial API Key Auth<a id="commercial-api-key-auth"></a>
+
+```python
+get_all_account_orders_response = (
+    commercial_api_key_client.experimental_endpoints.get_all_account_orders(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+    )
+)
+```
+
+Required credentials for this mode:
+
+- `user_id` (str, required): SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
+
+- `user_secret` (str, required): SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
+
+##### Personal API Key Auth<a id="personal-api-key-auth"></a>
+
+```python
+get_all_account_orders_response = (
+    personal_api_key_client.experimental_endpoints.get_all_account_orders(
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+    )
+)
+```
+
+The client identifies the user in this mode. Do not pass `user_id` `user_secret` to this method.
+
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_id: `str`<a id="account_id-str"></a>
+
+##### state: `str`<a id="state-str"></a>
+
+defaults to \"all\"
+
+##### days: `int`<a id="days-int"></a>
+
+Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AllAccountOrdersResponse`](./snaptrade_client/type/all_account_orders_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/all` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `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 brokerage order ID provided as a path parameter.
@@ -4239,4 +4291,3 @@ The client identifies the user in this mode. Do not pass `user_id` `user_secret`
 
 ## Author<a id="author"></a>
 This Python package is automatically generated by [Konfig](https://konfigthis.com)
-

{snaptrade_python_sdk-13.0.46 → snaptrade_python_sdk-13.0.47}/pyproject.toml

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

{snaptrade_python_sdk-13.0.46 → snaptrade_python_sdk-13.0.47}/snaptrade_client/__init__.py

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

{snaptrade_python_sdk-13.0.46 → snaptrade_python_sdk-13.0.47}/snaptrade_client/api_client.py

@@ -1175,7 +1175,7 @@ class ApiClient(typing.Generic[TAuth]):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Konfig/13.0.46/python'
+        self.user_agent = 'Konfig/13.0.47/python'
 
     def __enter__(self):
         return self

{snaptrade_python_sdk-13.0.46 → snaptrade_python_sdk-13.0.47}/snaptrade_client/apis/path_to_api.py

@@ -50,6 +50,7 @@ from snaptrade_client.apis.paths.snap_trade_trade_detection_subscriptions_cancel
 from snaptrade_client.apis.paths.management_stats import ManagementStats
 from snaptrade_client.apis.paths.snap_trade_stats import SnapTradeStats
 from snaptrade_client.apis.paths.accounts_account_id_orders_v2 import AccountsAccountIdOrdersV2
+from snaptrade_client.apis.paths.accounts_account_id_orders_all import AccountsAccountIdOrdersAll
 from snaptrade_client.apis.paths.accounts_account_id_recent_orders_v2 import AccountsAccountIdRecentOrdersV2
 from snaptrade_client.apis.paths.accounts_account_id_symbols import AccountsAccountIdSymbols
 from snaptrade_client.apis.paths.brokerages import Brokerages
@@ -114,6 +115,7 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.MANAGEMENT_STATS: ManagementStats,
         PathValues.SNAP_TRADE_STATS: SnapTradeStats,
         PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_V2: AccountsAccountIdOrdersV2,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_ALL: AccountsAccountIdOrdersAll,
         PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS_V2: AccountsAccountIdRecentOrdersV2,
         PathValues.ACCOUNTS_ACCOUNT_ID_SYMBOLS: AccountsAccountIdSymbols,
         PathValues.BROKERAGES: Brokerages,
@@ -179,6 +181,7 @@ path_to_api = PathToApi(
         PathValues.MANAGEMENT_STATS: ManagementStats,
         PathValues.SNAP_TRADE_STATS: SnapTradeStats,
         PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_V2: AccountsAccountIdOrdersV2,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_ALL: AccountsAccountIdOrdersAll,
         PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS_V2: AccountsAccountIdRecentOrdersV2,
         PathValues.ACCOUNTS_ACCOUNT_ID_SYMBOLS: AccountsAccountIdSymbols,
         PathValues.BROKERAGES: Brokerages,

snaptrade_python_sdk-13.0.47/snaptrade_client/apis/paths/accounts_account_id_orders_all.py

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

{snaptrade_python_sdk-13.0.46 → snaptrade_python_sdk-13.0.47}/snaptrade_client/apis/tags/experimental_endpoints_api_generated.py

@@ -11,6 +11,7 @@
 
 from snaptrade_client.paths.snap_trade_trade_detection_subscriptions.post import AddSubscription
 from snaptrade_client.paths.snap_trade_trade_detection_subscriptions_cancel.post import CancelSubscription
+from snaptrade_client.paths.accounts_account_id_orders_all.get import GetAllAccountOrders
 from snaptrade_client.paths.accounts_account_id_orders_details_v2_brokerage_order_id.get 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
@@ -25,6 +26,7 @@ TAuth = typing.TypeVar("TAuth", bound=AuthMode)
 class ExperimentalEndpointsApiGenerated(
     AddSubscription[TAuth],
     CancelSubscription[TAuth],
+    GetAllAccountOrders[TAuth],
     GetUserAccountOrderDetailV2[TAuth],
     GetUserAccountOrdersV2[TAuth],
     GetUserAccountRecentOrdersV2[TAuth],

{snaptrade_python_sdk-13.0.46 → snaptrade_python_sdk-13.0.47}/snaptrade_client/configuration.py

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