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

snaptrade_client/paths/{accounts_account_id_trading_simple_brokerage_order_id_replace/patch.pyi → accounts_account_id_trading_replace/post.pyi}

@@ -88,12 +88,10 @@ request_query_user_secret = api_client.QueryParameter(
 )
 # Path params
 AccountIdSchema = schemas.UUIDSchema
-BrokerageOrderIdSchema = schemas.StrSchema
 RequestRequiredPathParams = typing_extensions.TypedDict(
     'RequestRequiredPathParams',
     {
         'accountId': typing.Union[AccountIdSchema, str, uuid.UUID, ],
-        'brokerageOrderId': typing.Union[BrokerageOrderIdSchema, str, ],
     }
 )
 RequestOptionalPathParams = typing_extensions.TypedDict(
@@ -114,12 +112,6 @@ request_path_account_id = api_client.PathParameter(
     schema=AccountIdSchema,
     required=True,
 )
-request_path_brokerage_order_id = api_client.PathParameter(
-    name="brokerageOrderId",
-    style=api_client.ParameterStyle.SIMPLE,
-    schema=BrokerageOrderIdSchema,
-    required=True,
-)
 # body param
 SchemaForRequestBodyApplicationJson = ManualTradeReplaceFormSchema
 
@@ -220,11 +212,11 @@ class BaseApi(api_client.Api):
     def _replace_order_mapped_args(
         self,
         body: typing.Optional[ManualTradeReplaceForm] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         action: typing.Optional[ActionStrict] = None,
         order_type: typing.Optional[OrderTypeStrict] = None,
         time_in_force: typing.Optional[TimeInForceStrict] = None,
         account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         price: typing.Optional[typing.Optional[typing.Union[int, float]]] = None,
@@ -238,6 +230,8 @@ class BaseApi(api_client.Api):
         _query_params = {}
         _path_params = {}
         _body = {}
+        if brokerage_order_id is not None:
+            _body["brokerage_order_id"] = brokerage_order_id
         if action is not None:
             _body["action"] = action
         if order_type is not None:
@@ -259,8 +253,6 @@ class BaseApi(api_client.Api):
             _query_params["userSecret"] = user_secret
         if account_id is not None:
             _path_params["accountId"] = account_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
@@ -294,7 +286,6 @@ class BaseApi(api_client.Api):
         _path_params = {}
         for parameter in (
             request_path_account_id,
-            request_path_brokerage_order_id,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -324,7 +315,7 @@ class BaseApi(api_client.Api):
         if accept_content_types:
             for accept_content_type in accept_content_types:
                 _headers.add('Accept', accept_content_type)
-        method = 'patch'.upper()
+        method = 'post'.upper()
         _headers.add('Content-Type', content_type)
     
         if body is schemas.unset:
@@ -336,7 +327,7 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/trading/simple/{brokerageOrderId}/replace',
+            path_template='/accounts/{accountId}/trading/replace',
             body=body,
             auth_settings=_auth,
             headers=_headers,
@@ -441,7 +432,6 @@ class BaseApi(api_client.Api):
         _path_params = {}
         for parameter in (
             request_path_account_id,
-            request_path_brokerage_order_id,
         ):
             parameter_data = path_params.get(parameter.name, schemas.unset)
             if parameter_data is schemas.unset:
@@ -471,7 +461,7 @@ class BaseApi(api_client.Api):
         if accept_content_types:
             for accept_content_type in accept_content_types:
                 _headers.add('Accept', accept_content_type)
-        method = 'patch'.upper()
+        method = 'post'.upper()
         _headers.add('Content-Type', content_type)
     
         if body is schemas.unset:
@@ -483,7 +473,7 @@ class BaseApi(api_client.Api):
             resource_path=used_path,
             method=method,
             configuration=self.api_client.configuration,
-            path_template='/accounts/{accountId}/trading/simple/{brokerageOrderId}/replace',
+            path_template='/accounts/{accountId}/trading/replace',
             body=body,
             auth_settings=_auth,
             headers=_headers,
@@ -536,11 +526,11 @@ class ReplaceOrder(BaseApi):
     async def areplace_order(
         self,
         body: typing.Optional[ManualTradeReplaceForm] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         action: typing.Optional[ActionStrict] = None,
         order_type: typing.Optional[OrderTypeStrict] = None,
         time_in_force: typing.Optional[TimeInForceStrict] = None,
         account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         price: typing.Optional[typing.Optional[typing.Union[int, float]]] = None,
@@ -559,11 +549,11 @@ class ReplaceOrder(BaseApi):
             body=body,
             query_params=query_params,
             path_params=path_params,
+            brokerage_order_id=brokerage_order_id,
             action=action,
             order_type=order_type,
             time_in_force=time_in_force,
             account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
             user_id=user_id,
             user_secret=user_secret,
             price=price,
@@ -581,11 +571,11 @@ class ReplaceOrder(BaseApi):
     def replace_order(
         self,
         body: typing.Optional[ManualTradeReplaceForm] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         action: typing.Optional[ActionStrict] = None,
         order_type: typing.Optional[OrderTypeStrict] = None,
         time_in_force: typing.Optional[TimeInForceStrict] = None,
         account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         price: typing.Optional[typing.Optional[typing.Union[int, float]]] = None,
@@ -603,11 +593,11 @@ class ReplaceOrder(BaseApi):
             body=body,
             query_params=query_params,
             path_params=path_params,
+            brokerage_order_id=brokerage_order_id,
             action=action,
             order_type=order_type,
             time_in_force=time_in_force,
             account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
             user_id=user_id,
             user_secret=user_secret,
             price=price,
@@ -621,17 +611,17 @@ class ReplaceOrder(BaseApi):
             path_params=args.path,
         )
 
-class ApiForpatch(BaseApi):
+class ApiForpost(BaseApi):
     # this class is used by api classes that refer to endpoints by path and http method names
 
-    async def apatch(
+    async def apost(
         self,
         body: typing.Optional[ManualTradeReplaceForm] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         action: typing.Optional[ActionStrict] = None,
         order_type: typing.Optional[OrderTypeStrict] = None,
         time_in_force: typing.Optional[TimeInForceStrict] = None,
         account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         price: typing.Optional[typing.Optional[typing.Union[int, float]]] = None,
@@ -650,11 +640,11 @@ class ApiForpatch(BaseApi):
             body=body,
             query_params=query_params,
             path_params=path_params,
+            brokerage_order_id=brokerage_order_id,
             action=action,
             order_type=order_type,
             time_in_force=time_in_force,
             account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
             user_id=user_id,
             user_secret=user_secret,
             price=price,
@@ -669,14 +659,14 @@ class ApiForpatch(BaseApi):
             **kwargs,
         )
     
-    def patch(
+    def post(
         self,
         body: typing.Optional[ManualTradeReplaceForm] = None,
+        brokerage_order_id: typing.Optional[str] = None,
         action: typing.Optional[ActionStrict] = None,
         order_type: typing.Optional[OrderTypeStrict] = None,
         time_in_force: typing.Optional[TimeInForceStrict] = None,
         account_id: typing.Optional[str] = None,
-        brokerage_order_id: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
         user_secret: typing.Optional[str] = None,
         price: typing.Optional[typing.Optional[typing.Union[int, float]]] = None,
@@ -694,11 +684,11 @@ class ApiForpatch(BaseApi):
             body=body,
             query_params=query_params,
             path_params=path_params,
+            brokerage_order_id=brokerage_order_id,
             action=action,
             order_type=order_type,
             time_in_force=time_in_force,
             account_id=account_id,
-            brokerage_order_id=brokerage_order_id,
             user_id=user_id,
             user_secret=user_secret,
             price=price,

snaptrade_client/paths/brokerages_brokerage_id_instruments/get.py

@@ -143,7 +143,7 @@ class BaseApi(api_client.Api):
         AsyncGeneratorResponse,
     ]:
         """
-        Get a list of instruments available on the brokerage.
+        Get brokerage instruments
         :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
@@ -260,7 +260,7 @@ class BaseApi(api_client.Api):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Get a list of instruments available on the brokerage.
+        Get brokerage instruments
         :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
@@ -365,7 +365,7 @@ class ListAllBrokerageInstruments(BaseApi):
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list. """
+        """ Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. """
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
             brokerage_id=brokerage_id,
@@ -406,7 +406,7 @@ class ApiForget(BaseApi):
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list. """
+        """ Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. """
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
             brokerage_id=brokerage_id,

snaptrade_client/paths/brokerages_brokerage_id_instruments/get.pyi

@@ -132,7 +132,7 @@ class BaseApi(api_client.Api):
         AsyncGeneratorResponse,
     ]:
         """
-        Get a list of instruments available on the brokerage.
+        Get brokerage instruments
         :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
@@ -249,7 +249,7 @@ class BaseApi(api_client.Api):
         api_client.ApiResponseWithoutDeserialization,
     ]:
         """
-        Get a list of instruments available on the brokerage.
+        Get brokerage instruments
         :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
@@ -354,7 +354,7 @@ class ListAllBrokerageInstruments(BaseApi):
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list. """
+        """ Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. """
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
             brokerage_id=brokerage_id,
@@ -395,7 +395,7 @@ class ApiForget(BaseApi):
         ApiResponseForDefault,
         api_client.ApiResponseWithoutDeserialization,
     ]:
-        """ Returns a list of all brokerage instruments available for a given brokerage, optionally filtered by a search. Not all brokerages support this. The ones that don't will return an empty list. """
+        """ Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list. """
         args = self._list_all_brokerage_instruments_mapped_args(
             path_params=path_params,
             brokerage_id=brokerage_id,

snaptrade_client/type/crypto_order_form.py

@@ -0,0 +1,50 @@
+# 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 datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+from snaptrade_client.type.action_strict import ActionStrict
+from snaptrade_client.type.crypto_trading_instrument import CryptoTradingInstrument
+
+class RequiredCryptoOrderForm(TypedDict):
+    instrument: CryptoTradingInstrument
+
+    side: ActionStrict
+
+    # The type of order to place.
+    type: str
+
+    # The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date. 
+    time_in_force: str
+
+    # The amount of the base currency to buy or sell.
+    amount: str
+
+
+class OptionalCryptoOrderForm(TypedDict, total=False):
+    # The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
+    limit_price: str
+
+    # The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
+    stop_price: str
+
+    # Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees. 
+    post_only: bool
+
+    # The expiration date of the order. Required if the time_in_force is GTD.
+    expiration_date: datetime
+
+class CryptoOrderForm(RequiredCryptoOrderForm, OptionalCryptoOrderForm):
+    pass

snaptrade_client/type/{simple_order_preview.py → crypto_order_preview.py}

@@ -15,13 +15,13 @@ import typing
 from enum import Enum
 from typing_extensions import TypedDict, Literal, TYPE_CHECKING
 
-from snaptrade_client.type.simple_order_preview_estimated_fee import SimpleOrderPreviewEstimatedFee
+from snaptrade_client.type.crypto_order_preview_estimated_fee import CryptoOrderPreviewEstimatedFee
 
-class RequiredSimpleOrderPreview(TypedDict):
+class RequiredCryptoOrderPreview(TypedDict):
     pass
 
-class OptionalSimpleOrderPreview(TypedDict, total=False):
-    estimated_fee: SimpleOrderPreviewEstimatedFee
+class OptionalCryptoOrderPreview(TypedDict, total=False):
+    estimated_fee: CryptoOrderPreviewEstimatedFee
 
-class SimpleOrderPreview(RequiredSimpleOrderPreview, OptionalSimpleOrderPreview):
+class CryptoOrderPreview(RequiredCryptoOrderPreview, OptionalCryptoOrderPreview):
     pass

snaptrade_client/type/{simple_order_preview_estimated_fee.py → crypto_order_preview_estimated_fee.py}

@@ -16,14 +16,14 @@ from enum import Enum
 from typing_extensions import TypedDict, Literal, TYPE_CHECKING
 
 
-class RequiredSimpleOrderPreviewEstimatedFee(TypedDict):
+class RequiredCryptoOrderPreviewEstimatedFee(TypedDict):
     # Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes.
     currency: str
 
     amount: str
 
-class OptionalSimpleOrderPreviewEstimatedFee(TypedDict, total=False):
+class OptionalCryptoOrderPreviewEstimatedFee(TypedDict, total=False):
     pass
 
-class SimpleOrderPreviewEstimatedFee(RequiredSimpleOrderPreviewEstimatedFee, OptionalSimpleOrderPreviewEstimatedFee):
+class CryptoOrderPreviewEstimatedFee(RequiredCryptoOrderPreviewEstimatedFee, OptionalCryptoOrderPreviewEstimatedFee):
     pass

snaptrade_client/type/crypto_trading_instrument.py

@@ -0,0 +1,30 @@
+# 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 datetime import datetime, date
+import typing
+from enum import Enum
+from typing_extensions import TypedDict, Literal, TYPE_CHECKING
+
+
+class RequiredCryptoTradingInstrument(TypedDict):
+    # The instrument's trading ticker symbol
+    symbol: str
+
+    # The instrument's type
+    type: str
+
+class OptionalCryptoTradingInstrument(TypedDict, total=False):
+    pass
+
+class CryptoTradingInstrument(RequiredCryptoTradingInstrument, OptionalCryptoTradingInstrument):
+    pass

snaptrade_client/type/manual_trade_replace_form.py

@@ -21,6 +21,9 @@ from snaptrade_client.type.time_in_force_strict import TimeInForceStrict
 from snaptrade_client.type.units_nullable import UnitsNullable
 
 class RequiredManualTradeReplaceForm(TypedDict):
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    brokerage_order_id: str
+
     action: ActionStrict
 
     order_type: OrderTypeStrict