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

snaptrade_client/schemas.py

@@ -7,7 +7,7 @@
 
     The version of the OpenAPI document: 1.0.0
     Contact: api@snaptrade.com
-    Generated by: https://konfigthis.com
+    Created by: https://snaptrade.com/
 """
 
 from collections import defaultdict
@@ -387,7 +387,13 @@ class Schema:
         FileIO = openapi binary type and the user inputs a file
         bytes = openapi binary type and the user inputs bytes
         """
-        return super(Schema, cls).__new__(cls, arg)
+        try:
+            # In some cases (e.g. an int with enforced minimum value) this will throw an error:
+            # TypeError('object.__new__(DynamicSchema) is not safe, use DynamicSchema.__new__()')
+            res = super(Schema, cls).__new__(cls, arg)
+        except TypeError:
+            res = cls.__new__(cls, arg)
+        return res
 
     @classmethod
     def from_openapi_data_oapg(
@@ -969,6 +975,40 @@ class StrBase(ValidatorBase):
         return super()._validate_oapg(arg, validation_metadata=validation_metadata)
 
 
+class IntBase:
+    @property
+    def as_int_oapg(self) -> int:
+        try:
+            return self._as_int
+        except AttributeError:
+            self._as_int = int(self)
+            return self._as_int
+
+    @classmethod
+    def __validate_format(cls, arg: typing.Optional[decimal.Decimal], validation_metadata: ValidationMetadata):
+        if isinstance(arg, decimal.Decimal):
+
+            denominator = arg.as_integer_ratio()[-1]
+            if denominator != 1:
+                raise ApiValueError(
+                    "Invalid value '{}' for type integer at {}".format(arg, validation_metadata.path_to_item)
+                )
+
+    @classmethod
+    def _validate_oapg(
+        cls,
+        arg,
+        validation_metadata: ValidationMetadata,
+    ):
+        """
+        IntBase _validate_oapg
+        TODO what about types = (int, number) -> IntBase, NumberBase? We could drop int and keep number only
+        """
+        if cls._types and int not in cls._types: cls._types.add(int)
+        cls.__validate_format(arg, validation_metadata=validation_metadata)
+        return super()._validate_oapg(arg, validation_metadata=validation_metadata)
+
+
 class UUIDBase:
     @property
     @functools.lru_cache()
@@ -1835,7 +1875,7 @@ class ComposedBase(Discriminable):
                 continue
             try:
                 path_to_schemas = oneof_cls._validate_oapg(arg, validation_metadata=validation_metadata)
-            except (ApiValueError, ApiTypeError) as ex:
+            except (ApiValueError, ApiTypeError, SchemaValidationError) as ex:
                 if discriminated_cls is not None and oneof_cls is discriminated_cls:
                     raise ex
                 continue
@@ -1870,7 +1910,7 @@ class ComposedBase(Discriminable):
 
             try:
                 other_path_to_schemas = anyof_cls._validate_oapg(arg, validation_metadata=validation_metadata)
-            except (ApiValueError, ApiTypeError) as ex:
+            except (ApiValueError, ApiTypeError, SchemaValidationError) as ex:
                 if discriminated_cls is not None and anyof_cls is discriminated_cls:
                     raise ex
                 exceptions.append(ex)
@@ -1986,6 +2026,7 @@ class ComposedSchema(
     ComposedBase,
     DictBase,
     ListBase,
+    IntBase,
     NumberBase,
     StrBase,
     BoolBase,
@@ -2048,39 +2089,6 @@ class NumberSchema(
         return super().__new__(cls, arg, **kwargs)
 
 
-class IntBase:
-    @property
-    def as_int_oapg(self) -> int:
-        try:
-            return self._as_int
-        except AttributeError:
-            self._as_int = int(self)
-            return self._as_int
-
-    @classmethod
-    def __validate_format(cls, arg: typing.Optional[decimal.Decimal], validation_metadata: ValidationMetadata):
-        if isinstance(arg, decimal.Decimal):
-
-            denominator = arg.as_integer_ratio()[-1]
-            if denominator != 1:
-                raise ApiValueError(
-                    "Invalid value '{}' for type integer at {}".format(arg, validation_metadata.path_to_item)
-                )
-
-    @classmethod
-    def _validate_oapg(
-        cls,
-        arg,
-        validation_metadata: ValidationMetadata,
-    ):
-        """
-        IntBase _validate_oapg
-        TODO what about types = (int, number) -> IntBase, NumberBase? We could drop int and keep number only
-        """
-        cls.__validate_format(arg, validation_metadata=validation_metadata)
-        return super()._validate_oapg(arg, validation_metadata=validation_metadata)
-
-
 class IntSchema(IntBase, NumberBase, Schema, IntMixin):
 
     @classmethod

snaptrade_client/type/account.py

@@ -0,0 +1,68 @@
+# 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_balance import AccountBalance
+from snaptrade_client.type.account_cash_restrictions import AccountCashRestrictions
+from snaptrade_client.type.account_meta import AccountMeta
+from snaptrade_client.type.account_sync_status import AccountSyncStatus
+
+class RequiredAccount(TypedDict):
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
+    id: str
+
+    # Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
+    brokerage_authorization: str
+
+    # A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
+    name: typing.Optional[str]
+
+    # The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
+    number: str
+
+    # The name of the brokerage that holds the account.
+    institution_name: str
+
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage.
+    created_date: datetime
+
+    sync_status: AccountSyncStatus
+
+    balance: AccountBalance
+
+    # Indicates whether the account is a paper (simulated) trading account.
+    is_paper: bool
+
+
+class OptionalAccount(TypedDict, total=False):
+    # The current status of the account. Can be either \"open\", \"closed\", \"archived\" or null if the status is unknown or not provided by the brokerage.
+    status: typing.Optional[str]
+
+    # The account type as provided by the brokerage
+    raw_type: typing.Optional[str]
+
+    # WARNING: This property is deprecated
+    meta: AccountMeta
+
+    # WARNING: This property is deprecated
+    # Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
+    portfolio_group: str
+
+    # WARNING: This property is deprecated
+    cash_restrictions: AccountCashRestrictions
+
+class Account(RequiredAccount, OptionalAccount):
+    pass

snaptrade_client/type/account_balance.py

@@ -0,0 +1,27 @@
+# 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 RequiredAccountBalance(TypedDict):
+    pass
+
+class OptionalAccountBalance(TypedDict, total=False):
+    # Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.
+    total: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class AccountBalance(RequiredAccountBalance, OptionalAccountBalance):
+    pass

snaptrade_client/type/account_cash_restrictions.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
+
+
+AccountCashRestrictions = typing.List[str]

snaptrade_client/type/account_holdings.py

@@ -0,0 +1,37 @@
+# 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.balance import Balance
+from snaptrade_client.type.position import Position
+from snaptrade_client.type.snap_trade_holdings_account import SnapTradeHoldingsAccount
+from snaptrade_client.type.snap_trade_holdings_total_value import SnapTradeHoldingsTotalValue
+
+class RequiredAccountHoldings(TypedDict):
+    pass
+
+class OptionalAccountHoldings(TypedDict, total=False):
+    account: SnapTradeHoldingsAccount
+
+    balances: typing.Optional[typing.List[Balance]]
+
+    positions: typing.Optional[typing.List[Position]]
+
+    # WARNING: This property is deprecated
+    total_value: SnapTradeHoldingsTotalValue
+
+class AccountHoldings(RequiredAccountHoldings, OptionalAccountHoldings):
+    pass

snaptrade_client/type/account_holdings_account.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.account import Account
+from snaptrade_client.type.account_order_record import AccountOrderRecord
+from snaptrade_client.type.balance import Balance
+from snaptrade_client.type.options_position import OptionsPosition
+from snaptrade_client.type.position import Position
+from snaptrade_client.type.snap_trade_holdings_total_value import SnapTradeHoldingsTotalValue
+
+class RequiredAccountHoldingsAccount(TypedDict):
+    pass
+
+class OptionalAccountHoldingsAccount(TypedDict, total=False):
+    account: Account
+
+    # List of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
+    balances: typing.Optional[typing.List[Balance]]
+
+    # List of stock/ETF/crypto/mutual fund positions in the account.
+    positions: typing.Optional[typing.List[Position]]
+
+    # List of option positions in the account.
+    option_positions: typing.Optional[typing.List[OptionsPosition]]
+
+    # List of recent orders in the account, including both pending and executed orders. Note that option orders are included in this list. Option orders will have a null `universal_symbol` field and a non-null `option_symbol` field.
+    orders: typing.Optional[typing.List[AccountOrderRecord]]
+
+    # WARNING: This property is deprecated
+    total_value: SnapTradeHoldingsTotalValue
+
+class AccountHoldingsAccount(RequiredAccountHoldingsAccount, OptionalAccountHoldingsAccount):
+    pass

snaptrade_client/type/account_id.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
+
+
+AccountID = str

snaptrade_client/type/account_ids.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
+
+
+AccountIDs = str

snaptrade_client/type/account_meta.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
+
+
+AccountMeta = dict

snaptrade_client/type/account_order_record.py

@@ -0,0 +1,94 @@
+# 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_status import AccountOrderRecordStatus
+from snaptrade_client.type.child_brokerage_order_ids_nullable import ChildBrokerageOrderIDsNullable
+from snaptrade_client.type.currency import Currency
+from snaptrade_client.type.options_symbol import OptionsSymbol
+from snaptrade_client.type.universal_symbol import UniversalSymbol
+
+class RequiredAccountOrderRecord(TypedDict):
+    pass
+
+class OptionalAccountOrderRecord(TypedDict, total=False):
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    brokerage_order_id: str
+
+    status: AccountOrderRecordStatus
+
+    # Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated.
+    universal_symbol: UniversalSymbol
+
+    # Contains information about the option contract that the order is for. This field is only present for option orders. For stock/ETF/crypto/mutual fund orders, this field will be null and the `universal_symbol` field will be populated.
+    option_symbol: OptionsSymbol
+
+    # Quote cryptocurrency. This field is only present for cryptocurrency pair orders with a cryptocurrency as quote.
+    quote_universal_symbol: UniversalSymbol
+
+    # Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote.
+    quote_currency: Currency
+
+    # The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE 
+    action: str
+
+    # The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
+    total_quantity: typing.Optional[str]
+
+    # The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
+    open_quantity: typing.Optional[str]
+
+    # The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
+    canceled_quantity: typing.Optional[str]
+
+    # The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
+    filled_quantity: typing.Optional[str]
+
+    # The price at which the order was executed.
+    execution_price: typing.Optional[typing.Union[int, float]]
+
+    # The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders.
+    limit_price: typing.Optional[typing.Union[int, float]]
+
+    # The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders.
+    stop_price: typing.Optional[typing.Union[int, float]]
+
+    # The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage's order type value.
+    order_type: typing.Optional[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. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage's time in force value.   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `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.   - `MOO` - Market On Open. The order is to be executed at the day's opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close. 
+    time_in_force: str
+
+    # The time the order was placed. This is the time the order was submitted to the brokerage.
+    time_placed: datetime
+
+    # The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
+    time_updated: typing.Optional[datetime]
+
+    # The time the order was executed in the brokerage system. This value is not always available from the brokerage.
+    time_executed: typing.Optional[datetime]
+
+    # The time the order expires. This value is not always available from the brokerage.
+    expiry_date: typing.Optional[datetime]
+
+    # 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.
+    symbol: str
+
+    child_brokerage_order_ids: typing.Optional[ChildBrokerageOrderIDsNullable]
+
+class AccountOrderRecord(RequiredAccountOrderRecord, OptionalAccountOrderRecord):
+    pass

snaptrade_client/type/account_order_record_leg.py

@@ -0,0 +1,48 @@
+# 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_leg_instrument import AccountOrderRecordLegInstrument
+from snaptrade_client.type.account_order_record_status_v2_nullable import AccountOrderRecordStatusV2Nullable
+
+class RequiredAccountOrderRecordLeg(TypedDict):
+    pass
+
+class OptionalAccountOrderRecordLeg(TypedDict, total=False):
+    # Brokerage order identifier for this leg, if available.
+    leg_id: typing.Optional[str]
+
+    instrument: AccountOrderRecordLegInstrument
+
+    # The action describes the intent or side of a trade.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_TO_OPEN   - BUY_TO_CLOSE   - SELL_TO_OPEN   - SELL_TO_CLOSE 
+    action: str
+
+    # Execution price for this leg, if available.
+    execution_price: typing.Optional[typing.Union[int, float]]
+
+    # The total number of shares or contracts associated with this leg. Can be a decimal number for fractional shares.
+    total_quantity: typing.Optional[str]
+
+    # The number of shares or contracts that have been canceled for this leg.
+    canceled_quantity: typing.Optional[str]
+
+    # The number of shares or contracts that have been filled for this leg.
+    filled_quantity: typing.Optional[str]
+
+    status: typing.Optional[AccountOrderRecordStatusV2Nullable]
+
+class AccountOrderRecordLeg(RequiredAccountOrderRecordLeg, OptionalAccountOrderRecordLeg):
+    pass

snaptrade_client/type/account_order_record_leg_instrument.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 RequiredAccountOrderRecordLegInstrument(TypedDict):
+    pass
+
+class OptionalAccountOrderRecordLegInstrument(TypedDict, total=False):
+    # The symbol or ticker for the security.
+    symbol: str
+
+    # Human-readable description of the security.
+    description: str
+
+    # Type of instrument for the leg. - EQUITY - OPTION - CRYPTO 
+    asset_type: str
+
+    # Market Identifier Code (MIC) for the exchange on which the instrument trades.
+    exchange_mic_code: str
+
+    # Financial Instrument Global Identifier (FIGI) if available.
+    figi_code: typing.Optional[str]
+
+class AccountOrderRecordLegInstrument(RequiredAccountOrderRecordLegInstrument, OptionalAccountOrderRecordLegInstrument):
+    pass

snaptrade_client/type/account_order_record_status.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
+
+
+AccountOrderRecordStatus = Literal["NONE", "PENDING", "ACCEPTED", "FAILED", "REJECTED", "CANCELED", "PARTIAL_CANCELED", "CANCEL_PENDING", "EXECUTED", "PARTIAL", "REPLACE_PENDING", "REPLACED", "STOPPED", "SUSPENDED", "EXPIRED", "QUEUED", "TRIGGERED", "ACTIVATED", "PENDING_RISK_REVIEW", "CONTINGENT_ORDER"]

snaptrade_client/type/account_order_record_status_v2.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
+
+
+AccountOrderRecordStatusV2 = Literal["PENDING", "REJECTED", "CANCELED", "CANCEL_PENDING", "PARTIAL_CANCELED", "EXECUTED", "PARTIALLY_EXECUTED", "REPLACED", "REPLACE_PENDING", "EXPIRED"]

snaptrade_client/type/account_order_record_status_v2_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
+
+
+AccountOrderRecordStatusV2Nullable = Literal["PENDING", "REJECTED", "CANCELED", "CANCEL_PENDING", "PARTIAL_CANCELED", "EXECUTED", "PARTIALLY_EXECUTED", "REPLACED", "REPLACE_PENDING", "EXPIRED"]