snaptrade-python-sdk 11.0.117__py3-none-any.whl → 11.0.119__py3-none-any.whl

snaptrade_client/models/__init__.py

@@ -49,6 +49,10 @@ from snaptrade_client.model.cancel_order_response_raw_response import CancelOrde
 from snaptrade_client.model.child_brokerage_order_ids import ChildBrokerageOrderIDs
 from snaptrade_client.model.child_brokerage_order_ids_nullable import ChildBrokerageOrderIDsNullable
 from snaptrade_client.model.client_id import ClientID
+from snaptrade_client.model.crypto_order_form import CryptoOrderForm
+from snaptrade_client.model.crypto_order_preview import CryptoOrderPreview
+from snaptrade_client.model.crypto_order_preview_estimated_fee import CryptoOrderPreviewEstimatedFee
+from snaptrade_client.model.crypto_trading_instrument import CryptoTradingInstrument
 from snaptrade_client.model.cryptocurrency_base_symbol import CryptocurrencyBaseSymbol
 from snaptrade_client.model.cryptocurrency_pair import CryptocurrencyPair
 from snaptrade_client.model.cryptocurrency_pair_quote import CryptocurrencyPairQuote
@@ -140,8 +144,6 @@ from snaptrade_client.model.security_type import SecurityType
 from snaptrade_client.model.security_type_id import SecurityTypeID
 from snaptrade_client.model.session_event import SessionEvent
 from snaptrade_client.model.simple_order_form import SimpleOrderForm
-from snaptrade_client.model.simple_order_preview import SimpleOrderPreview
-from snaptrade_client.model.simple_order_preview_estimated_fee import SimpleOrderPreviewEstimatedFee
 from snaptrade_client.model.snap_trade_holdings_account import SnapTradeHoldingsAccount
 from snaptrade_client.model.snap_trade_holdings_account_meta import SnapTradeHoldingsAccountMeta
 from snaptrade_client.model.snap_trade_holdings_total_value import SnapTradeHoldingsTotalValue

snaptrade_client/operation_parameter_map.py

@@ -625,6 +625,46 @@ operation_parameter_map = {
             },
         ]
     },
+    '/accounts/{accountId}/trading/crypto-POST': {
+        'parameters': [
+            {
+                'name': 'instrument'
+            },
+            {
+                'name': 'side'
+            },
+            {
+                'name': 'type'
+            },
+            {
+                'name': 'time_in_force'
+            },
+            {
+                'name': 'amount'
+            },
+            {
+                'name': 'userId'
+            },
+            {
+                'name': 'userSecret'
+            },
+            {
+                'name': 'accountId'
+            },
+            {
+                'name': 'limit_price'
+            },
+            {
+                'name': 'stop_price'
+            },
+            {
+                'name': 'post_only'
+            },
+            {
+                'name': 'expiration_date'
+            },
+        ]
+    },
     '/trade/place-POST': {
         'parameters': [
             {
@@ -712,7 +752,7 @@ operation_parameter_map = {
             },
         ]
     },
-    '/accounts/{accountId}/trading/simple-POST': {
+    '/accounts/{accountId}/trading/crypto/preview-POST': {
         'parameters': [
             {
                 'name': 'instrument'
@@ -752,48 +792,11 @@ operation_parameter_map = {
             },
         ]
     },
-    '/accounts/{accountId}/trading/simple/preview-POST': {
+    '/accounts/{accountId}/trading/replace-POST': {
         'parameters': [
             {
-                'name': 'instrument'
-            },
-            {
-                'name': 'side'
-            },
-            {
-                'name': 'type'
-            },
-            {
-                'name': 'time_in_force'
-            },
-            {
-                'name': 'amount'
-            },
-            {
-                'name': 'userId'
-            },
-            {
-                'name': 'userSecret'
-            },
-            {
-                'name': 'accountId'
-            },
-            {
-                'name': 'limit_price'
-            },
-            {
-                'name': 'stop_price'
-            },
-            {
-                'name': 'post_only'
+                'name': 'brokerage_order_id'
             },
-            {
-                'name': 'expiration_date'
-            },
-        ]
-    },
-    '/accounts/{accountId}/trading/simple/{brokerageOrderId}/replace-PATCH': {
-        'parameters': [
             {
                 'name': 'action'
             },
@@ -806,9 +809,6 @@ operation_parameter_map = {
             {
                 'name': 'accountId'
             },
-            {
-                'name': 'brokerageOrderId'
-            },
             {
                 'name': 'userId'
             },

snaptrade_client/paths/__init__.py

@@ -43,11 +43,11 @@ class PathValues(str, enum.Enum):
     ACCOUNTS_ACCOUNT_ID_TRADING_BRACKET = "/accounts/{accountId}/trading/bracket"
     ACCOUNTS_ACCOUNT_ID_TRADING_OPTIONS = "/accounts/{accountId}/trading/options"
     ACCOUNTS_ACCOUNT_ID_TRADING_INSTRUMENTS_CRYPTOCURRENCY_PAIRS = "/accounts/{accountId}/trading/instruments/cryptocurrencyPairs"
-    ACCOUNTS_ACCOUNT_ID_TRADING_SIMPLE_PREVIEW = "/accounts/{accountId}/trading/simple/preview"
     ACCOUNTS_ACCOUNT_ID_TRADING_INSTRUMENTS_CRYPTOCURRENCY_PAIRS_INSTRUMENT_SYMBOL_QUOTE = "/accounts/{accountId}/trading/instruments/cryptocurrencyPairs/{instrumentSymbol}/quote"
-    ACCOUNTS_ACCOUNT_ID_TRADING_SIMPLE = "/accounts/{accountId}/trading/simple"
-    ACCOUNTS_ACCOUNT_ID_TRADING_SIMPLE_BROKERAGE_ORDER_ID_REPLACE = "/accounts/{accountId}/trading/simple/{brokerageOrderId}/replace"
+    ACCOUNTS_ACCOUNT_ID_TRADING_REPLACE = "/accounts/{accountId}/trading/replace"
     ACCOUNTS_ACCOUNT_ID_TRADING_CANCEL = "/accounts/{accountId}/trading/cancel"
+    ACCOUNTS_ACCOUNT_ID_TRADING_CRYPTO = "/accounts/{accountId}/trading/crypto"
+    ACCOUNTS_ACCOUNT_ID_TRADING_CRYPTO_PREVIEW = "/accounts/{accountId}/trading/crypto/preview"
     SNAP_TRADE_PARTNERS = "/snapTrade/partners"
     ACCOUNTS_ACCOUNT_ID_SYMBOLS = "/accounts/{accountId}/symbols"
     BROKERAGES = "/brokerages"

snaptrade_client/paths/accounts_account_id_orders_cancel/post.py

@@ -537,6 +537,7 @@ class BaseApi(api_client.Api):
 class CancelUserAccountOrder(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
+    @api_client.DeprecationWarningOnce(prefix="trading")
     async def acancel_user_account_order(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -568,6 +569,7 @@ class CancelUserAccountOrder(BaseApi):
             **kwargs,
         )
     
+    @api_client.DeprecationWarningOnce(prefix="trading")
     def cancel_user_account_order(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -581,7 +583,7 @@ class CancelUserAccountOrder(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
+        """ **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
         args = self._cancel_user_account_order_mapped_args(
             body=body,
             query_params=query_params,
@@ -600,6 +602,7 @@ class CancelUserAccountOrder(BaseApi):
 class ApiForpost(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
+    @api_client.DeprecationWarningOnce(prefix="trading")
     async def apost(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -631,6 +634,7 @@ class ApiForpost(BaseApi):
             **kwargs,
         )
     
+    @api_client.DeprecationWarningOnce(prefix="trading")
     def post(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -644,7 +648,7 @@ class ApiForpost(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
+        """ **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
         args = self._cancel_user_account_order_mapped_args(
             body=body,
             query_params=query_params,

snaptrade_client/paths/accounts_account_id_orders_cancel/post.pyi

@@ -525,6 +525,7 @@ class BaseApi(api_client.Api):
 class CancelUserAccountOrder(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
+    @api_client.DeprecationWarningOnce(prefix="trading")
     async def acancel_user_account_order(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -556,6 +557,7 @@ class CancelUserAccountOrder(BaseApi):
             **kwargs,
         )
     
+    @api_client.DeprecationWarningOnce(prefix="trading")
     def cancel_user_account_order(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -569,7 +571,7 @@ class CancelUserAccountOrder(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
+        """ **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
         args = self._cancel_user_account_order_mapped_args(
             body=body,
             query_params=query_params,
@@ -588,6 +590,7 @@ class CancelUserAccountOrder(BaseApi):
 class ApiForpost(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
+    @api_client.DeprecationWarningOnce(prefix="trading")
     async def apost(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -619,6 +622,7 @@ class ApiForpost(BaseApi):
             **kwargs,
         )
     
+    @api_client.DeprecationWarningOnce(prefix="trading")
     def post(
         self,
         body: typing.Optional[typing.Any] = None,
@@ -632,7 +636,7 @@ class ApiForpost(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
+        """ **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.  """
         args = self._cancel_user_account_order_mapped_args(
             body=body,
             query_params=query_params,

snaptrade_client/paths/accounts_account_id_trading_cancel/post.py

@@ -574,7 +574,7 @@ class CancelOrder(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Cancels an order in the specified account.  """
+        """ Cancels an order in the specified account. Accepts order IDs for all asset types.  """
         args = self._cancel_order_mapped_args(
             body=body,
             query_params=query_params,
@@ -637,7 +637,7 @@ class ApiForpost(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Cancels an order in the specified account.  """
+        """ Cancels an order in the specified account. Accepts order IDs for all asset types.  """
         args = self._cancel_order_mapped_args(
             body=body,
             query_params=query_params,

snaptrade_client/paths/accounts_account_id_trading_cancel/post.pyi

@@ -562,7 +562,7 @@ class CancelOrder(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Cancels an order in the specified account.  """
+        """ Cancels an order in the specified account. Accepts order IDs for all asset types.  """
         args = self._cancel_order_mapped_args(
             body=body,
             query_params=query_params,
@@ -625,7 +625,7 @@ class ApiForpost(BaseApi):
         ApiResponseFor200,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Cancels an order in the specified account.  """
+        """ Cancels an order in the specified account. Accepts order IDs for all asset types.  """
         args = self._cancel_order_mapped_args(
             body=body,
             query_params=query_params,

snaptrade_client/paths/{accounts_account_id_trading_simple → accounts_account_id_trading_crypto}/__init__.py

@@ -1,7 +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_trading_simple import Api
+# from snaptrade_client.paths.accounts_account_id_trading_crypto import Api
 
 from snaptrade_client.paths import PathValues
 
-path = PathValues.ACCOUNTS_ACCOUNT_ID_TRADING_SIMPLE
+path = PathValues.ACCOUNTS_ACCOUNT_ID_TRADING_CRYPTO

snaptrade_client/paths/{accounts_account_id_trading_simple → accounts_account_id_trading_crypto}/post.py

@@ -32,16 +32,16 @@ import frozendict  # noqa: F401
 
 from snaptrade_client import schemas  # noqa: F401
 
-from snaptrade_client.model.trading_instrument import TradingInstrument as TradingInstrumentSchema
 from snaptrade_client.model.model400_failed_request_response import Model400FailedRequestResponse as Model400FailedRequestResponseSchema
 from snaptrade_client.model.action_strict import ActionStrict as ActionStrictSchema
-from snaptrade_client.model.simple_order_form import SimpleOrderForm as SimpleOrderFormSchema
+from snaptrade_client.model.crypto_order_form import CryptoOrderForm as CryptoOrderFormSchema
+from snaptrade_client.model.crypto_trading_instrument import CryptoTradingInstrument as CryptoTradingInstrumentSchema
 from snaptrade_client.model.order_updated_response import OrderUpdatedResponse as OrderUpdatedResponseSchema
 
-from snaptrade_client.type.trading_instrument import TradingInstrument
+from snaptrade_client.type.crypto_order_form import CryptoOrderForm
 from snaptrade_client.type.model400_failed_request_response import Model400FailedRequestResponse
+from snaptrade_client.type.crypto_trading_instrument import CryptoTradingInstrument
 from snaptrade_client.type.action_strict import ActionStrict
-from snaptrade_client.type.simple_order_form import SimpleOrderForm
 from snaptrade_client.type.order_updated_response import OrderUpdatedResponse
 
 from . import path
@@ -109,10 +109,10 @@ request_path_account_id = api_client.PathParameter(
     required=True,
 )
 # body param
-SchemaForRequestBodyApplicationJson = SimpleOrderFormSchema
+SchemaForRequestBodyApplicationJson = CryptoOrderFormSchema
 
 
-request_body_simple_order_form = api_client.RequestBody(
+request_body_crypto_order_form = api_client.RequestBody(
     content={
         'application/json': api_client.MediaType(
             schema=SchemaForRequestBodyApplicationJson),
@@ -194,10 +194,10 @@ _all_accept_content_types = (
 
 class BaseApi(api_client.Api):
 
-    def _place_simple_order_mapped_args(
+    def _place_crypto_order_mapped_args(
         self,
-        body: typing.Optional[SimpleOrderForm] = None,
-        instrument: typing.Optional[TradingInstrument] = None,
+        body: typing.Optional[CryptoOrderForm] = None,
+        instrument: typing.Optional[CryptoTradingInstrument] = None,
         side: typing.Optional[ActionStrict] = None,
         type: typing.Optional[str] = None,
         time_in_force: typing.Optional[str] = None,
@@ -245,7 +245,7 @@ class BaseApi(api_client.Api):
         args.path = path_params if path_params else _path_params
         return args
 
-    async def _aplace_simple_order_oapg(
+    async def _aplace_crypto_order_oapg(
         self,
         body: typing.Any = None,
         query_params: typing.Optional[dict] = {},
@@ -315,12 +315,12 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/trading/simple',
+            path_template='/accounts/{accountId}/trading/crypto',
             body=body,
             auth_settings=_auth,
             headers=_headers,
         )
-        serialized_data = request_body_simple_order_form.serialize(body, content_type)
+        serialized_data = request_body_crypto_order_form.serialize(body, content_type)
         if 'fields' in serialized_data:
             _fields = serialized_data['fields']
         elif 'body' in serialized_data:
@@ -393,7 +393,7 @@ class BaseApi(api_client.Api):
         return api_response
 
 
-    def _place_simple_order_oapg(
+    def _place_crypto_order_oapg(
         self,
         body: typing.Any = None,
         query_params: typing.Optional[dict] = {},
@@ -461,12 +461,12 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/trading/simple',
+            path_template='/accounts/{accountId}/trading/crypto',
             body=body,
             auth_settings=_auth,
             headers=_headers,
         )
-        serialized_data = request_body_simple_order_form.serialize(body, content_type)
+        serialized_data = request_body_crypto_order_form.serialize(body, content_type)
         if 'fields' in serialized_data:
             _fields = serialized_data['fields']
         elif 'body' in serialized_data:
@@ -508,13 +508,13 @@ class BaseApi(api_client.Api):
         return api_response
 
 
-class PlaceSimpleOrder(BaseApi):
+class PlaceCryptoOrder(BaseApi):
     # this class is used by api classes that refer to endpoints with operationId fn names
 
-    async def aplace_simple_order(
+    async def aplace_crypto_order(
         self,
-        body: typing.Optional[SimpleOrderForm] = None,
-        instrument: typing.Optional[TradingInstrument] = None,
+        body: typing.Optional[CryptoOrderForm] = None,
+        instrument: typing.Optional[CryptoTradingInstrument] = None,
         side: typing.Optional[ActionStrict] = None,
         type: typing.Optional[str] = None,
         time_in_force: typing.Optional[str] = None,
@@ -534,7 +534,7 @@ class PlaceSimpleOrder(BaseApi):
         api_client.ApiResponseWithoutDeserializationAsync,
         AsyncGeneratorResponse,
     ]:
-        args = self._place_simple_order_mapped_args(
+        args = self._place_crypto_order_mapped_args(
             body=body,
             query_params=query_params,
             path_params=path_params,
@@ -551,17 +551,17 @@ class PlaceSimpleOrder(BaseApi):
             post_only=post_only,
             expiration_date=expiration_date,
         )
-        return await self._aplace_simple_order_oapg(
+        return await self._aplace_crypto_order_oapg(
             body=args.body,
             query_params=args.query,
             path_params=args.path,
             **kwargs,
         )
     
-    def place_simple_order(
+    def place_crypto_order(
         self,
-        body: typing.Optional[SimpleOrderForm] = None,
-        instrument: typing.Optional[TradingInstrument] = None,
+        body: typing.Optional[CryptoOrderForm] = None,
+        instrument: typing.Optional[CryptoTradingInstrument] = None,
         side: typing.Optional[ActionStrict] = None,
         type: typing.Optional[str] = None,
         time_in_force: typing.Optional[str] = None,
@@ -580,7 +580,7 @@ class PlaceSimpleOrder(BaseApi):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """ Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.  """
-        args = self._place_simple_order_mapped_args(
+        args = self._place_crypto_order_mapped_args(
             body=body,
             query_params=query_params,
             path_params=path_params,
@@ -597,7 +597,7 @@ class PlaceSimpleOrder(BaseApi):
             post_only=post_only,
             expiration_date=expiration_date,
         )
-        return self._place_simple_order_oapg(
+        return self._place_crypto_order_oapg(
             body=args.body,
             query_params=args.query,
             path_params=args.path,
@@ -608,8 +608,8 @@ class ApiForpost(BaseApi):
 
     async def apost(
         self,
-        body: typing.Optional[SimpleOrderForm] = None,
-        instrument: typing.Optional[TradingInstrument] = None,
+        body: typing.Optional[CryptoOrderForm] = None,
+        instrument: typing.Optional[CryptoTradingInstrument] = None,
         side: typing.Optional[ActionStrict] = None,
         type: typing.Optional[str] = None,
         time_in_force: typing.Optional[str] = None,
@@ -629,7 +629,7 @@ class ApiForpost(BaseApi):
         api_client.ApiResponseWithoutDeserializationAsync,
         AsyncGeneratorResponse,
     ]:
-        args = self._place_simple_order_mapped_args(
+        args = self._place_crypto_order_mapped_args(
             body=body,
             query_params=query_params,
             path_params=path_params,
@@ -646,7 +646,7 @@ class ApiForpost(BaseApi):
             post_only=post_only,
             expiration_date=expiration_date,
         )
-        return await self._aplace_simple_order_oapg(
+        return await self._aplace_crypto_order_oapg(
             body=args.body,
             query_params=args.query,
             path_params=args.path,
@@ -655,8 +655,8 @@ class ApiForpost(BaseApi):
     
     def post(
         self,
-        body: typing.Optional[SimpleOrderForm] = None,
-        instrument: typing.Optional[TradingInstrument] = None,
+        body: typing.Optional[CryptoOrderForm] = None,
+        instrument: typing.Optional[CryptoTradingInstrument] = None,
         side: typing.Optional[ActionStrict] = None,
         type: typing.Optional[str] = None,
         time_in_force: typing.Optional[str] = None,
@@ -675,7 +675,7 @@ class ApiForpost(BaseApi):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """ Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.  """
-        args = self._place_simple_order_mapped_args(
+        args = self._place_crypto_order_mapped_args(
             body=body,
             query_params=query_params,
             path_params=path_params,
@@ -692,7 +692,7 @@ class ApiForpost(BaseApi):
             post_only=post_only,
             expiration_date=expiration_date,
         )
-        return self._place_simple_order_oapg(
+        return self._place_crypto_order_oapg(
             body=args.body,
             query_params=args.query,
             path_params=args.path,