snaptrade-python-sdk 10.9.0__py3-none-any.whl → 11.0.152__py3-none-any.whl

snaptrade_client/type/manual_trade_form_bracket.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_with_options import ActionStrictWithOptions
+from snaptrade_client.type.order_type_strict import OrderTypeStrict
+from snaptrade_client.type.stop_loss import StopLoss
+from snaptrade_client.type.take_profit import TakeProfit
+from snaptrade_client.type.time_in_force_strict import TimeInForceStrict
+from snaptrade_client.type.trading_instrument import TradingInstrument
+
+class RequiredManualTradeFormBracket(TypedDict):
+    action: ActionStrictWithOptions
+
+    instrument: TradingInstrument
+
+    order_type: OrderTypeStrict
+
+    time_in_force: TimeInForceStrict
+
+    stop_loss: StopLoss
+
+    take_profit: TakeProfit
+
+
+class OptionalManualTradeFormBracket(TypedDict, total=False):
+    # The limit price for `Limit` and `StopLimit` orders.
+    price: typing.Optional[typing.Union[int, float]]
+
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+    stop: typing.Optional[typing.Union[int, float]]
+
+    # Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
+    units: typing.Union[int, float]
+
+class ManualTradeFormBracket(RequiredManualTradeFormBracket, OptionalManualTradeFormBracket):
+    pass

snaptrade_client/type/manual_trade_form_with_options.py

@@ -0,0 +1,57 @@
+# 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_with_options import ActionStrictWithOptions
+from snaptrade_client.type.notional_value_nullable import NotionalValueNullable
+from snaptrade_client.type.order_type_strict import OrderTypeStrict
+from snaptrade_client.type.time_in_force_strict import TimeInForceStrict
+from snaptrade_client.type.trading_session import TradingSession
+from snaptrade_client.type.universal_symbol_id_nullable import UniversalSymbolIDNullable
+
+class RequiredManualTradeFormWithOptions(TypedDict):
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    account_id: str
+
+    action: ActionStrictWithOptions
+
+    order_type: OrderTypeStrict
+
+    time_in_force: TimeInForceStrict
+
+
+class OptionalManualTradeFormWithOptions(TypedDict, total=False):
+    # The universal symbol ID of the security to trade. Must be 'null' if `symbol` is provided, otherwise must be provided.
+    universal_symbol_id: UniversalSymbolIDNullable
+
+    # The security's trading ticker symbol. If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
+    symbol: typing.Optional[str]
+
+    trading_session: TradingSession
+
+    # The limit price for `Limit` and `StopLimit` orders.
+    price: typing.Optional[typing.Union[int, float]]
+
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+    stop: typing.Optional[typing.Union[int, float]]
+
+    # For Equity orders, this represents the number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided. If placing an Option order, this field represents the number of contracts to buy or sell. (e.g., 1 contract = 100 shares).
+    units: float
+
+    notional_value: typing.Optional[NotionalValueNullable]
+
+class ManualTradeFormWithOptions(RequiredManualTradeFormWithOptions, OptionalManualTradeFormWithOptions):
+    pass

snaptrade_client/type/manual_trade_impact.py

@@ -0,0 +1,39 @@
+# 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 RequiredManualTradeImpact(TypedDict):
+    pass
+
+class OptionalManualTradeImpact(TypedDict, total=False):
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    account: str
+
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+    currency: str
+
+    # Estimated amount of cash remaining in the account after the trade.
+    remaining_cash: typing.Optional[typing.Union[int, float]]
+
+    # Estimated commission for the trade.
+    estimated_commission: typing.Optional[typing.Union[int, float]]
+
+    # Estimated foreign transaction fees for the trade.
+    forex_fees: typing.Optional[typing.Union[int, float]]
+
+class ManualTradeImpact(RequiredManualTradeImpact, OptionalManualTradeImpact):
+    pass

snaptrade_client/type/manual_trade_replace_form.py

@@ -0,0 +1,47 @@
+# 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.order_type_strict import OrderTypeStrict
+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
+
+    time_in_force: TimeInForceStrict
+
+
+class OptionalManualTradeReplaceForm(TypedDict, total=False):
+    # The limit price for `Limit` and `StopLimit` orders.
+    price: typing.Optional[typing.Union[int, float]]
+
+    # The security's trading ticker symbol
+    symbol: str
+
+    # The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
+    stop: typing.Optional[typing.Union[int, float]]
+
+    units: UnitsNullable
+
+class ManualTradeReplaceForm(RequiredManualTradeReplaceForm, OptionalManualTradeReplaceForm):
+    pass

snaptrade_client/type/manual_trade_symbol.py

@@ -0,0 +1,46 @@
+# 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.currency import Currency
+
+class RequiredManualTradeSymbol(TypedDict):
+    pass
+
+class OptionalManualTradeSymbol(TypedDict, total=False):
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    universal_symbol_id: str
+
+    currency: Currency
+
+    # WARNING: This property is deprecated
+    # This field is deprecated and should not be used.
+    local_id: str
+
+    # WARNING: This property is deprecated
+    # This field is deprecated and should not be used.
+    description: typing.Optional[str]
+
+    # WARNING: This property is deprecated
+    # This field is deprecated and should not be used.
+    symbol: str
+
+    # WARNING: This property is deprecated
+    # A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
+    brokerage_symbol_id: str
+
+class ManualTradeSymbol(RequiredManualTradeSymbol, OptionalManualTradeSymbol):
+    pass

snaptrade_client/type/mleg_action_strict.py

@@ -0,0 +1,19 @@
+# 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
+
+
+MlegActionStrict = Literal["BUY", "SELL", "BUY_TO_OPEN", "BUY_TO_CLOSE", "SELL_TO_OPEN", "SELL_TO_CLOSE"]

snaptrade_client/type/mleg_instrument_type.py

@@ -0,0 +1,19 @@
+# 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
+
+
+MlegInstrumentType = Literal["OPTION", "EQUITY"]

snaptrade_client/type/mleg_leg.py

@@ -0,0 +1,33 @@
+# 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.mleg_action_strict import MlegActionStrict
+from snaptrade_client.type.mleg_trading_instrument import MlegTradingInstrument
+
+class RequiredMlegLeg(TypedDict):
+    instrument: MlegTradingInstrument
+
+    action: MlegActionStrict
+
+    # The quantity to trade. For options this represents the number of contracts. For equity this represents the number of shares.
+    units: int
+
+class OptionalMlegLeg(TypedDict, total=False):
+    pass
+
+class MlegLeg(RequiredMlegLeg, OptionalMlegLeg):
+    pass

snaptrade_client/type/mleg_order_response.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
+
+from snaptrade_client.type.account_order_record import AccountOrderRecord
+
+class RequiredMlegOrderResponse(TypedDict):
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    brokerage_order_id: str
+
+    orders: typing.List[AccountOrderRecord]
+
+class OptionalMlegOrderResponse(TypedDict, total=False):
+    pass
+
+class MlegOrderResponse(RequiredMlegOrderResponse, OptionalMlegOrderResponse):
+    pass

snaptrade_client/type/mleg_order_type_strict.py

@@ -0,0 +1,19 @@
+# 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
+
+
+MlegOrderTypeStrict = Literal["MARKET", "LIMIT", "STOP_LOSS_MARKET", "STOP_LOSS_LIMIT"]

snaptrade_client/type/mleg_price_effect_strict.py

@@ -0,0 +1,19 @@
+# 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
+
+
+MlegPriceEffectStrict = Literal["CREDIT", "DEBIT", "EVEN"]

snaptrade_client/type/mleg_price_effect_strict_nullable.py

@@ -0,0 +1,19 @@
+# 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
+
+
+MlegPriceEffectStrictNullable = Literal["CREDIT", "DEBIT", "EVEN"]

snaptrade_client/type/mleg_trade_form.py

@@ -0,0 +1,41 @@
+# 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.mleg_leg import MlegLeg
+from snaptrade_client.type.mleg_order_type_strict import MlegOrderTypeStrict
+from snaptrade_client.type.mleg_price_effect_strict_nullable import MlegPriceEffectStrictNullable
+from snaptrade_client.type.time_in_force_strict import TimeInForceStrict
+
+class RequiredMlegTradeForm(TypedDict):
+    order_type: MlegOrderTypeStrict
+
+    time_in_force: TimeInForceStrict
+
+    legs: typing.List[MlegLeg]
+
+
+class OptionalMlegTradeForm(TypedDict, total=False):
+    # The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
+    limit_price: typing.Optional[str]
+
+    # The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
+    stop_price: typing.Optional[str]
+
+    price_effect: typing.Optional[MlegPriceEffectStrictNullable]
+
+class MlegTradeForm(RequiredMlegTradeForm, OptionalMlegTradeForm):
+    pass

snaptrade_client/type/mleg_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
+
+from snaptrade_client.type.mleg_instrument_type import MlegInstrumentType
+
+class RequiredMlegTradingInstrument(TypedDict):
+    # The security's trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL  131124C00240000` represents a call option on AAPL expiring on 2024-11-13 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
+    symbol: str
+
+    instrument_type: MlegInstrumentType
+
+class OptionalMlegTradingInstrument(TypedDict, total=False):
+    pass
+
+class MlegTradingInstrument(RequiredMlegTradingInstrument, OptionalMlegTradingInstrument):
+    pass

snaptrade_client/type/model400_failed_request_response.py

@@ -0,0 +1,28 @@
+# 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 RequiredModel400FailedRequestResponse(TypedDict):
+    pass
+
+class OptionalModel400FailedRequestResponse(TypedDict, total=False):
+    default_detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    default_code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model400FailedRequestResponse(RequiredModel400FailedRequestResponse, OptionalModel400FailedRequestResponse):
+    pass

snaptrade_client/type/model401_failed_request_response.py

@@ -0,0 +1,28 @@
+# 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 RequiredModel401FailedRequestResponse(TypedDict):
+    pass
+
+class OptionalModel401FailedRequestResponse(TypedDict, total=False):
+    default_detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    default_code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model401FailedRequestResponse(RequiredModel401FailedRequestResponse, OptionalModel401FailedRequestResponse):
+    pass

snaptrade_client/type/model402_brokerage_auth_already_disabled_exception.py

@@ -0,0 +1,28 @@
+# 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 RequiredModel402BrokerageAuthAlreadyDisabledException(TypedDict):
+    pass
+
+class OptionalModel402BrokerageAuthAlreadyDisabledException(TypedDict, total=False):
+    detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model402BrokerageAuthAlreadyDisabledException(RequiredModel402BrokerageAuthAlreadyDisabledException, OptionalModel402BrokerageAuthAlreadyDisabledException):
+    pass

snaptrade_client/type/model402_brokerage_auth_disabled_response.py

@@ -0,0 +1,28 @@
+# 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 RequiredModel402BrokerageAuthDisabledResponse(TypedDict):
+    pass
+
+class OptionalModel402BrokerageAuthDisabledResponse(TypedDict, total=False):
+    detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model402BrokerageAuthDisabledResponse(RequiredModel402BrokerageAuthDisabledResponse, OptionalModel402BrokerageAuthDisabledResponse):
+    pass

snaptrade_client/type/model403_failed_request_response.py

@@ -0,0 +1,28 @@
+# 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 RequiredModel403FailedRequestResponse(TypedDict):
+    pass
+
+class OptionalModel403FailedRequestResponse(TypedDict, total=False):
+    default_detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    default_code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model403FailedRequestResponse(RequiredModel403FailedRequestResponse, OptionalModel403FailedRequestResponse):
+    pass

snaptrade_client/type/model403_feature_not_enabled_response.py

@@ -0,0 +1,28 @@
+# 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 RequiredModel403FeatureNotEnabledResponse(TypedDict):
+    pass
+
+class OptionalModel403FeatureNotEnabledResponse(TypedDict, total=False):
+    detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    default_code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model403FeatureNotEnabledResponse(RequiredModel403FeatureNotEnabledResponse, OptionalModel403FeatureNotEnabledResponse):
+    pass