snaptrade-python-sdk 11.0.143__tar.gz → 11.0.144__tar.gz

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 11.0.143
+Version: 11.0.144
 Summary: Client for SnapTrade
 License: MIT
 Author: SnapTrade
@@ -30,7 +30,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.143-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.143)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.144-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.144)
 [![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 +70,8 @@ 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_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)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
@@ -109,7 +111,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.143
+pip install snaptrade-python-sdk==11.0.144
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1209,6 +1211,103 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
+### `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.
+
+The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.
+
+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>
+
+```python
+get_user_account_orders_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_orders_v2(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+    )
+)
+```
+
+#### ⚙️ 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>
+
+##### state: `str`<a id="state-str"></a>
+
+defaults value is set 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.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrdersV2Response`](./snaptrade_client/type/account_orders_v2_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/v2` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_recent_orders_v2"></a>
+
+A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
+This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders.
+Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
+By default only returns executed orders, but that can be changed by setting *only_executed* to false.
+**Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_recent_orders_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_recent_orders_v2(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        only_executed=True,
+    )
+)
+```
+
+#### ⚙️ 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>
+
+##### only_executed: `bool`<a id="only_executed-bool"></a>
+
+Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrdersV2Response`](./snaptrade_client/type/account_orders_v2_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/recentOrders/v2` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
 
 Returns the option chain for the specified symbol in the specified account.

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/README.md

@@ -7,7 +7,7 @@
 Connect brokerage accounts to your app for live positions and trading
 
 
-[![PyPI](https://img.shields.io/badge/PyPI-v11.0.143-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.143)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.144-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.144)
 [![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 +47,8 @@ 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_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)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
@@ -86,7 +88,7 @@ Python >=3.8
 ## Installation<a id="installation"></a>
 
 ```sh
-pip install snaptrade-python-sdk==11.0.143
+pip install snaptrade-python-sdk==11.0.144
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1186,6 +1188,103 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
+### `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.
+
+The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.
+
+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>
+
+```python
+get_user_account_orders_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_orders_v2(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        state="all",
+        days=30,
+    )
+)
+```
+
+#### ⚙️ 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>
+
+##### state: `str`<a id="state-str"></a>
+
+defaults value is set 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.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrdersV2Response`](./snaptrade_client/type/account_orders_v2_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/v2` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+### `snaptrade.experimental_endpoints.get_user_account_recent_orders_v2`<a id="snaptradeexperimental_endpointsget_user_account_recent_orders_v2"></a>
+
+A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
+This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders.
+Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
+By default only returns executed orders, but that can be changed by setting *only_executed* to false.
+**Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```python
+get_user_account_recent_orders_v2_response = (
+    snaptrade.experimental_endpoints.get_user_account_recent_orders_v2(
+        user_id="snaptrade-user-123",
+        user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
+        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        only_executed=True,
+    )
+)
+```
+
+#### ⚙️ 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>
+
+##### only_executed: `bool`<a id="only_executed-bool"></a>
+
+Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[`AccountOrdersV2Response`](./snaptrade_client/type/account_orders_v2_response.py)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/recentOrders/v2` `get`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
 ### `snaptrade.options.get_options_chain`<a id="snaptradeoptionsget_options_chain"></a>
 
 Returns the option chain for the specified symbol in the specified account.

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/pyproject.toml

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

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/snaptrade_client/__init__.py

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

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

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/snaptrade_client/apis/path_to_api.py

@@ -42,6 +42,8 @@ from snaptrade_client.apis.paths.accounts_account_id_trading_crypto import Accou
 from snaptrade_client.apis.paths.accounts_account_id_trading_cancel import AccountsAccountIdTradingCancel
 from snaptrade_client.apis.paths.accounts_account_id_trading_replace import AccountsAccountIdTradingReplace
 from snaptrade_client.apis.paths.snap_trade_partners import SnapTradePartners
+from snaptrade_client.apis.paths.accounts_account_id_orders_v2 import AccountsAccountIdOrdersV2
+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
 from snaptrade_client.apis.paths.brokerages_slug_instruments import BrokeragesSlugInstruments
@@ -98,6 +100,8 @@ PathToApi = typing_extensions.TypedDict(
         PathValues.ACCOUNTS_ACCOUNT_ID_TRADING_CANCEL: AccountsAccountIdTradingCancel,
         PathValues.ACCOUNTS_ACCOUNT_ID_TRADING_REPLACE: AccountsAccountIdTradingReplace,
         PathValues.SNAP_TRADE_PARTNERS: SnapTradePartners,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_V2: AccountsAccountIdOrdersV2,
+        PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS_V2: AccountsAccountIdRecentOrdersV2,
         PathValues.ACCOUNTS_ACCOUNT_ID_SYMBOLS: AccountsAccountIdSymbols,
         PathValues.BROKERAGES: Brokerages,
         PathValues.BROKERAGES_SLUG_INSTRUMENTS: BrokeragesSlugInstruments,
@@ -155,6 +159,8 @@ path_to_api = PathToApi(
         PathValues.ACCOUNTS_ACCOUNT_ID_TRADING_CANCEL: AccountsAccountIdTradingCancel,
         PathValues.ACCOUNTS_ACCOUNT_ID_TRADING_REPLACE: AccountsAccountIdTradingReplace,
         PathValues.SNAP_TRADE_PARTNERS: SnapTradePartners,
+        PathValues.ACCOUNTS_ACCOUNT_ID_ORDERS_V2: AccountsAccountIdOrdersV2,
+        PathValues.ACCOUNTS_ACCOUNT_ID_RECENT_ORDERS_V2: AccountsAccountIdRecentOrdersV2,
         PathValues.ACCOUNTS_ACCOUNT_ID_SYMBOLS: AccountsAccountIdSymbols,
         PathValues.BROKERAGES: Brokerages,
         PathValues.BROKERAGES_SLUG_INSTRUMENTS: BrokeragesSlugInstruments,

snaptrade_python_sdk-11.0.144/snaptrade_client/apis/paths/accounts_account_id_orders_v2.py

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

snaptrade_python_sdk-11.0.144/snaptrade_client/apis/paths/accounts_account_id_recent_orders_v2.py

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

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/snaptrade_client/apis/tag_to_api.py

@@ -9,6 +9,7 @@ from snaptrade_client.apis.tags.options_api import OptionsApi
 from snaptrade_client.apis.tags.transactions_and_reporting_api import TransactionsAndReportingApi
 from snaptrade_client.apis.tags.trading_api import TradingApi
 from snaptrade_client.apis.tags.reference_data_api import ReferenceDataApi
+from snaptrade_client.apis.tags.experimental_endpoints_api import ExperimentalEndpointsApi
 
 TagToApi = typing_extensions.TypedDict(
     'TagToApi',
@@ -21,6 +22,7 @@ TagToApi = typing_extensions.TypedDict(
         TagValues.TRANSACTIONS_AND_REPORTING: TransactionsAndReportingApi,
         TagValues.TRADING: TradingApi,
         TagValues.REFERENCE_DATA: ReferenceDataApi,
+        TagValues.EXPERIMENTAL_ENDPOINTS: ExperimentalEndpointsApi,
     }
 )
 
@@ -34,5 +36,6 @@ tag_to_api = TagToApi(
         TagValues.TRANSACTIONS_AND_REPORTING: TransactionsAndReportingApi,
         TagValues.TRADING: TradingApi,
         TagValues.REFERENCE_DATA: ReferenceDataApi,
+        TagValues.EXPERIMENTAL_ENDPOINTS: ExperimentalEndpointsApi,
     }
 )

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/snaptrade_client/apis/tags/__init__.py

@@ -14,3 +14,4 @@ class TagValues(str, enum.Enum):
     TRANSACTIONS_AND_REPORTING = "Transactions And Reporting"
     TRADING = "Trading"
     REFERENCE_DATA = "Reference Data"
+    EXPERIMENTAL_ENDPOINTS = "Experimental endpoints"

snaptrade_python_sdk-11.0.144/snaptrade_client/apis/tags/experimental_endpoints_api.py

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+from snaptrade_client.apis.tags.experimental_endpoints_api_generated import ExperimentalEndpointsApiGenerated
+
+class ExperimentalEndpointsApi(ExperimentalEndpointsApiGenerated):
+    pass

snaptrade_python_sdk-11.0.144/snaptrade_client/apis/tags/experimental_endpoints_api_generated.py

@@ -0,0 +1,23 @@
+# 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 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(
+    GetUserAccountOrdersV2,
+    GetUserAccountRecentOrdersV2,
+):
+    """NOTE:
+    This class is auto generated by Konfig (https://konfigthis.com)
+    """
+    pass

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/snaptrade_client/client.py

@@ -20,6 +20,7 @@ from snaptrade_client.apis.tags.account_information_api import AccountInformatio
 from snaptrade_client.apis.tags.api_status_api import APIStatusApi
 from snaptrade_client.apis.tags.authentication_api import AuthenticationApi
 from snaptrade_client.apis.tags.connections_api import ConnectionsApi
+from snaptrade_client.apis.tags.experimental_endpoints_api import ExperimentalEndpointsApi
 from snaptrade_client.apis.tags.options_api import OptionsApi
 from snaptrade_client.apis.tags.reference_data_api import ReferenceDataApi
 from snaptrade_client.apis.tags.trading_api import TradingApi
@@ -40,6 +41,7 @@ class SnapTrade(ClientCustom):
         self.api_status: APIStatusApi = APIStatusApi(api_client)
         self.authentication: AuthenticationApi = AuthenticationApi(api_client)
         self.connections: ConnectionsApi = ConnectionsApi(api_client)
+        self.experimental_endpoints: ExperimentalEndpointsApi = ExperimentalEndpointsApi(api_client)
         self.options: OptionsApi = OptionsApi(api_client)
         self.reference_data: ReferenceDataApi = ReferenceDataApi(api_client)
         self.trading: TradingApi = TradingApi(api_client)

{snaptrade_python_sdk-11.0.143 → snaptrade_python_sdk-11.0.144}/snaptrade_client/client.pyi

@@ -20,6 +20,7 @@ from snaptrade_client.apis.tags.account_information_api import AccountInformatio
 from snaptrade_client.apis.tags.api_status_api import APIStatusApi
 from snaptrade_client.apis.tags.authentication_api import AuthenticationApi
 from snaptrade_client.apis.tags.connections_api import ConnectionsApi
+from snaptrade_client.apis.tags.experimental_endpoints_api import ExperimentalEndpointsApi
 from snaptrade_client.apis.tags.options_api import OptionsApi
 from snaptrade_client.apis.tags.reference_data_api import ReferenceDataApi
 from snaptrade_client.apis.tags.trading_api import TradingApi
@@ -40,6 +41,7 @@ class SnapTrade(ClientCustom):
         self.api_status: APIStatusApi = APIStatusApi(api_client)
         self.authentication: AuthenticationApi = AuthenticationApi(api_client)
         self.connections: ConnectionsApi = ConnectionsApi(api_client)
+        self.experimental_endpoints: ExperimentalEndpointsApi = ExperimentalEndpointsApi(api_client)
         self.options: OptionsApi = OptionsApi(api_client)
         self.reference_data: ReferenceDataApi = ReferenceDataApi(api_client)
         self.trading: TradingApi = TradingApi(api_client)

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