snaptrade-python-sdk 11.0.122__py3-none-any.whl → 11.0.124__py3-none-any.whl

snaptrade_client/paths/{accounts_account_id_option_strategy_option_strategy_id → accounts_account_id_orders_brokerage_order_id}/get.pyi

@@ -32,11 +32,13 @@ import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
 
+from snaptrade_client.model.account_order_record import AccountOrderRecord as AccountOrderRecordSchema
 from snaptrade_client.model.model500_unexpected_exception_response import Model500UnexpectedExceptionResponse as Model500UnexpectedExceptionResponseSchema
-from snaptrade_client.model.strategy_quotes import StrategyQuotes as StrategyQuotesSchema
+from snaptrade_client.model.model404_failed_request_response import Model404FailedRequestResponse as Model404FailedRequestResponseSchema
 
-from snaptrade_client.type.strategy_quotes import StrategyQuotes
 from snaptrade_client.type.model500_unexpected_exception_response import Model500UnexpectedExceptionResponse
+from snaptrade_client.type.account_order_record import AccountOrderRecord
+from snaptrade_client.type.model404_failed_request_response import Model404FailedRequestResponse
 
 # Query params
 UserIdSchema = schemas.StrSchema
@@ -76,12 +78,12 @@ request_query_user_secret = api_client.QueryParameter(
 )
 # Path params
 AccountIdSchema = schemas.UUIDSchema
-OptionStrategyIdSchema = schemas.UUIDSchema
+BrokerageOrderIdSchema = schemas.StrSchema
 RequestRequiredPathParams = typing_extensions.TypedDict(
     'RequestRequiredPathParams',
     {
         'accountId': typing.Union[AccountIdSchema, str, uuid.UUID, ],
-        'optionStrategyId': typing.Union[OptionStrategyIdSchema, str, uuid.UUID, ],
+        'brokerageOrderId': typing.Union[BrokerageOrderIdSchema, str, ],
     }
 )
 RequestOptionalPathParams = typing_extensions.TypedDict(
@@ -102,23 +104,23 @@ request_path_account_id = api_client.PathParameter(
     schema=AccountIdSchema,
     required=True,
 )
-request_path_option_strategy_id = api_client.PathParameter(
-    name="optionStrategyId",
+request_path_brokerage_order_id = api_client.PathParameter(
+    name="brokerageOrderId",
     style=api_client.ParameterStyle.SIMPLE,
-    schema=OptionStrategyIdSchema,
+    schema=BrokerageOrderIdSchema,
     required=True,
 )
-SchemaFor200ResponseBodyApplicationJson = StrategyQuotesSchema
+SchemaFor200ResponseBodyApplicationJson = AccountOrderRecordSchema
 
 
 @dataclass
 class ApiResponseFor200(api_client.ApiResponse):
-    body: StrategyQuotes
+    body: AccountOrderRecord
 
 
 @dataclass
 class ApiResponseFor200Async(api_client.AsyncApiResponse):
-    body: StrategyQuotes
+    body: AccountOrderRecord
 
 
 _response_for_200 = api_client.OpenApiResponse(
@@ -129,6 +131,27 @@ _response_for_200 = api_client.OpenApiResponse(
             schema=SchemaFor200ResponseBodyApplicationJson),
     },
 )
+SchemaFor404ResponseBodyApplicationJson = Model404FailedRequestResponseSchema
+
+
+@dataclass
+class ApiResponseFor404(api_client.ApiResponse):
+    body: Model404FailedRequestResponse
+
+
+@dataclass
+class ApiResponseFor404Async(api_client.AsyncApiResponse):
+    body: Model404FailedRequestResponse
+
+
+_response_for_404 = api_client.OpenApiResponse(
+    response_cls=ApiResponseFor404,
+    response_cls_async=ApiResponseFor404Async,
+    content={
+        'application/json': api_client.MediaType(
+            schema=SchemaFor404ResponseBodyApplicationJson),
+    },
+)
 SchemaFor500ResponseBodyApplicationJson = Model500UnexpectedExceptionResponseSchema
 
 
@@ -157,12 +180,12 @@ _all_accept_content_types = (
 
 class BaseApi(api_client.Api):
 
-    def _get_options_strategy_quote_mapped_args(
+    def _get_user_account_order_detail_mapped_args(
         self,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
-        option_strategy_id: typing.Optional[str] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> api_client.MappedArgs:
@@ -175,13 +198,13 @@ class BaseApi(api_client.Api):
             _query_params["userSecret"] = user_secret
         if account_id is not None:
             _path_params["accountId"] = account_id
-        if option_strategy_id is not None:
-            _path_params["optionStrategyId"] = option_strategy_id
+        if brokerage_order_id is not None:
+            _path_params["brokerageOrderId"] = brokerage_order_id
         args.query = query_params if query_params else _query_params
         args.path = path_params if path_params else _path_params
         return args
 
-    async def _aget_options_strategy_quote_oapg(
+    async def _aget_user_account_order_detail_oapg(
         self,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
@@ -196,7 +219,7 @@ class BaseApi(api_client.Api):
         AsyncGeneratorResponse,
     ]:
         """
-        Get options strategy quotes
+        Get account order detail
         :param skip_deserialization: If true then api_response.response will be set but
             api_response.body and api_response.headers will not be deserialized into schema
             class instances
@@ -208,7 +231,7 @@ class BaseApi(api_client.Api):
         _path_params = {}
         for parameter in (
             request_path_account_id,
-            request_path_option_strategy_id,
+            request_path_brokerage_order_id,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -243,7 +266,7 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/optionStrategy/{optionStrategyId}',
+            path_template='/accounts/{accountId}/orders/{brokerageOrderId}',
             auth_settings=_auth,
             headers=_headers,
         )
@@ -312,7 +335,7 @@ class BaseApi(api_client.Api):
         return api_response
 
 
-    def _get_options_strategy_quote_oapg(
+    def _get_user_account_order_detail_oapg(
         self,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
@@ -325,7 +348,7 @@ class BaseApi(api_client.Api):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Get options strategy quotes
+        Get account order detail
         :param skip_deserialization: If true then api_response.response will be set but
             api_response.body and api_response.headers will not be deserialized into schema
             class instances
@@ -337,7 +360,7 @@ class BaseApi(api_client.Api):
         _path_params = {}
         for parameter in (
             request_path_account_id,
-            request_path_option_strategy_id,
+            request_path_brokerage_order_id,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -372,7 +395,7 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/optionStrategy/{optionStrategyId}',
+            path_template='/accounts/{accountId}/orders/{brokerageOrderId}',
             auth_settings=_auth,
             headers=_headers,
         )
@@ -410,15 +433,15 @@ class BaseApi(api_client.Api):
         return api_response
 
 
-class GetOptionsStrategyQuote(BaseApi):
+class GetUserAccountOrderDetail(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
-    async def aget_options_strategy_quote(
+    async def aget_user_account_order_detail(
         self,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
-        option_strategy_id: typing.Optional[str] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -427,42 +450,42 @@ class GetOptionsStrategyQuote(BaseApi):
         api_client.ApiResponseWithoutDeserializationAsync,
         AsyncGeneratorResponse,
     ]:
-        args = self._get_options_strategy_quote_mapped_args(
+        args = self._get_user_account_order_detail_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
-            option_strategy_id=option_strategy_id,
+            brokerage_order_id=brokerage_order_id,
         )
-        return await self._aget_options_strategy_quote_oapg(
+        return await self._aget_user_account_order_detail_oapg(
             query_params=args.query,
             path_params=args.path,
             **kwargs,
         )
     
-    def get_options_strategy_quote(
+    def get_user_account_order_detail(
         self,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
-        option_strategy_id: typing.Optional[str] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a Strategy Quotes object which has latest market data of the specified option strategy.  """
-        args = self._get_options_strategy_quote_mapped_args(
+        """ Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.  """
+        args = self._get_user_account_order_detail_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
-            option_strategy_id=option_strategy_id,
+            brokerage_order_id=brokerage_order_id,
         )
-        return self._get_options_strategy_quote_oapg(
+        return self._get_user_account_order_detail_oapg(
             query_params=args.query,
             path_params=args.path,
         )
@@ -475,7 +498,7 @@ class ApiForget(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
-        option_strategy_id: typing.Optional[str] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
         **kwargs,
@@ -484,15 +507,15 @@ class ApiForget(BaseApi):
         api_client.ApiResponseWithoutDeserializationAsync,
         AsyncGeneratorResponse,
     ]:
-        args = self._get_options_strategy_quote_mapped_args(
+        args = self._get_user_account_order_detail_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
-            option_strategy_id=option_strategy_id,
+            brokerage_order_id=brokerage_order_id,
         )
-        return await self._aget_options_strategy_quote_oapg(
+        return await self._aget_user_account_order_detail_oapg(
             query_params=args.query,
             path_params=args.path,
             **kwargs,
@@ -503,23 +526,23 @@ class ApiForget(BaseApi):
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         account_id: typing.Optional[str] = None,
-        option_strategy_id: typing.Optional[str] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         query_params: typing.Optional[dict] = {},
         path_params: typing.Optional[dict] = {},
     ) -> typing.Union[
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a Strategy Quotes object which has latest market data of the specified option strategy.  """
-        args = self._get_options_strategy_quote_mapped_args(
+        """ Returns the detail of a single order in the specified account. This endpoint is always realtime and does not rely on cached data.  """
+        args = self._get_user_account_order_detail_mapped_args(
             query_params=query_params,
             path_params=path_params,
             user_id=user_id,
             user_secret=user_secret,
             account_id=account_id,
-            option_strategy_id=option_strategy_id,
+            brokerage_order_id=brokerage_order_id,
         )
-        return self._get_options_strategy_quote_oapg(
+        return self._get_user_account_order_detail_oapg(
             query_params=args.query,
             path_params=args.path,
         )

{snaptrade_python_sdk-11.0.122.dist-info → snaptrade_python_sdk-11.0.124.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snaptrade-python-sdk
-Version: 11.0.122
+Version: 11.0.124
 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.122-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.122)
+[![PyPI](https://img.shields.io/badge/PyPI-v11.0.124-blue)](https://pypi.org/project/snaptrade-python-sdk/11.0.124)
 [![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 +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)
@@ -69,11 +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.options.get_option_strategy`](#snaptradeoptionsget_option_strategy)
   * [`snaptrade.options.get_options_chain`](#snaptradeoptionsget_options_chain)
-  * [`snaptrade.options.get_options_strategy_quote`](#snaptradeoptionsget_options_strategy_quote)
   * [`snaptrade.options.list_option_holdings`](#snaptradeoptionslist_option_holdings)
-  * [`snaptrade.options.place_option_strategy`](#snaptradeoptionsplace_option_strategy)
   * [`snaptrade.reference_data.get_currency_exchange_rate_pair`](#snaptradereference_dataget_currency_exchange_rate_pair)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
   * [`snaptrade.reference_data.get_security_types`](#snaptradereference_dataget_security_types)
@@ -111,7 +109,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.124
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -401,6 +399,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.
@@ -1143,61 +1181,6 @@ Optional comma separated list of session IDs used to filter the request on speci
 
 ---
 
-### `snaptrade.options.get_option_strategy`<a id="snaptradeoptionsget_option_strategy"></a>
-
-Creates an option strategy object that will be used to place an option strategy order.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```python
-get_option_strategy_response = snaptrade.options.get_option_strategy(
-    underlying_symbol_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
-    legs=[
-        {
-            "action": "BUY_TO_OPEN",
-            "option_symbol_id": "SPY220819P00200000",
-            "quantity": 1,
-        }
-    ],
-    strategy_type="CUSTOM",
-    user_id="snaptrade-user-123",
-    user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
-    account_id="accountId_example",
-)
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### underlying_symbol_id: `str`<a id="underlying_symbol_id-str"></a>
-
-##### legs: List[`OptionLeg`]<a id="legs-listoptionleg"></a>
-
-##### strategy_type: `str`<a id="strategy_type-str"></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>
-
-The ID of the account to create the option strategy object in.
-
-#### ⚙️ Request Body<a id="⚙️-request-body"></a>
-
-[`Any`](./snaptrade_client/type/typing_any.py)
-#### 🔄 Return<a id="🔄-return"></a>
-
-[`StrategyQuotes`](./snaptrade_client/type/strategy_quotes.py)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy` `post`
-
-[🔙 **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.
@@ -1239,48 +1222,6 @@ Universal symbol ID if symbol
 
 ---
 
-### `snaptrade.options.get_options_strategy_quote`<a id="snaptradeoptionsget_options_strategy_quote"></a>
-
-Returns a Strategy Quotes object which has latest market data of the specified option strategy.
-
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```python
-get_options_strategy_quote_response = snaptrade.options.get_options_strategy_quote(
-    user_id="snaptrade-user-123",
-    user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
-    account_id="accountId_example",
-    option_strategy_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
-)
-```
-
-#### ⚙️ 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>
-
-The ID of the account the strategy will be placed in.
-
-##### option_strategy_id: `str`<a id="option_strategy_id-str"></a>
-
-Option strategy id obtained from response when creating option strategy object
-
-#### 🔄 Return<a id="🔄-return"></a>
-
-[`StrategyQuotes`](./snaptrade_client/type/strategy_quotes.py)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy/{optionStrategyId}` `get`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
 ### `snaptrade.options.list_option_holdings`<a id="snaptradeoptionslist_option_holdings"></a>
 
 Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
@@ -1318,59 +1259,6 @@ list_option_holdings_response = snaptrade.options.list_option_holdings(
 
 ---
 
-### `snaptrade.options.place_option_strategy`<a id="snaptradeoptionsplace_option_strategy"></a>
-
-Places the option strategy order and returns the order record received from the brokerage.
-
-#### 🛠️ Usage<a id="🛠️-usage"></a>
-
-```python
-place_option_strategy_response = snaptrade.options.place_option_strategy(
-    order_type="Market",
-    time_in_force="Day",
-    user_id="snaptrade-user-123",
-    user_secret="adf2aa34-8219-40f7-a6b3-60156985cc61",
-    account_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
-    option_strategy_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
-    price=31.33,
-)
-```
-
-#### ⚙️ Parameters<a id="⚙️-parameters"></a>
-
-##### order_type: [`OrderTypeStrict`](./snaptrade_client/type/order_type_strict.py)<a id="order_type-ordertypestrictsnaptrade_clienttypeorder_type_strictpy"></a>
-
-##### time_in_force: [`TimeInForceStrict`](./snaptrade_client/type/time_in_force_strict.py)<a id="time_in_force-timeinforcestrictsnaptrade_clienttypetime_in_force_strictpy"></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>
-
-The ID of the account to execute the strategy in.
-
-##### option_strategy_id: `str`<a id="option_strategy_id-str"></a>
-
-Option strategy id obtained from response when creating option strategy object
-
-##### price: [`Price`](./snaptrade_client/type/price.py)<a id="price-pricesnaptrade_clienttypepricepy"></a>
-
-#### ⚙️ Request Body<a id="⚙️-request-body"></a>
-
-[`Any`](./snaptrade_client/type/typing_any.py)
-#### 🔄 Return<a id="🔄-return"></a>
-
-[`StrategyOrderRecord`](./snaptrade_client/type/strategy_order_record.py)
-
-#### 🌐 Endpoint<a id="🌐-endpoint"></a>
-
-`/accounts/{accountId}/optionStrategy/{optionStrategyId}/execute` `post`
-
-[🔙 **Back to Table of Contents**](#table-of-contents)
-
----
-
 ### `snaptrade.reference_data.get_currency_exchange_rate_pair`<a id="snaptradereference_dataget_currency_exchange_rate_pair"></a>
 
 Returns an Exchange Rate Pair object for the specified Currency Pair.