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

snaptrade_client/type/currency_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
+
+
+CurrencyID = str

snaptrade_client/type/currency_nullable.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
+
+
+class RequiredCurrencyNullable(TypedDict):
+    pass
+
+class OptionalCurrencyNullable(TypedDict, total=False):
+    # Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+    id: str
+
+    # The ISO-4217 currency code for the currency.
+    code: str
+
+    # A human-friendly name of the currency.
+    name: str
+
+class CurrencyNullable(RequiredCurrencyNullable, OptionalCurrencyNullable):
+    pass

snaptrade_client/type/delete_user_response.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
+
+
+class RequiredDeleteUserResponse(TypedDict):
+    pass
+
+class OptionalDeleteUserResponse(TypedDict, total=False):
+    # This is always `deleted` when a user is queued for deletion.
+    status: str
+
+    # Human friendly message about the deletion status.
+    detail: str
+
+    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
+    userId: str
+
+class DeleteUserResponse(RequiredDeleteUserResponse, OptionalDeleteUserResponse):
+    pass

snaptrade_client/type/dividend_at_date.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
+
+
+class RequiredDividendAtDate(TypedDict):
+    pass
+
+class OptionalDividendAtDate(TypedDict, total=False):
+    # The ticker of the symbol that the dividend came from
+    symbol: typing.Optional[str]
+
+    # The amount received from the dividend
+    amount: typing.Optional[typing.Union[int, float]]
+
+    # The currency of the amount
+    currency: str
+
+class DividendAtDate(RequiredDividendAtDate, OptionalDividendAtDate):
+    pass

snaptrade_client/type/encrypted_response.py

@@ -0,0 +1,29 @@
+# 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.encrypted_response_encrypted_message_data import EncryptedResponseEncryptedMessageData
+
+class RequiredEncryptedResponse(TypedDict):
+    pass
+
+class OptionalEncryptedResponse(TypedDict, total=False):
+    encryptedSharedKey: str
+
+    encryptedMessageData: EncryptedResponseEncryptedMessageData
+
+class EncryptedResponse(RequiredEncryptedResponse, OptionalEncryptedResponse):
+    pass

snaptrade_client/type/encrypted_response_encrypted_message_data.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 RequiredEncryptedResponseEncryptedMessageData(TypedDict):
+    pass
+
+class OptionalEncryptedResponseEncryptedMessageData(TypedDict, total=False):
+    encryptedMessage: str
+
+    tag: str
+
+    nonce: str
+
+class EncryptedResponseEncryptedMessageData(RequiredEncryptedResponseEncryptedMessageData, OptionalEncryptedResponseEncryptedMessageData):
+    pass

snaptrade_client/type/exchange.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
+
+
+class RequiredExchange(TypedDict):
+    pass
+
+class OptionalExchange(TypedDict, total=False):
+    # Unique ID for the exchange in SnapTrade.
+    id: str
+
+    # A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
+    code: str
+
+    # The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
+    mic_code: str
+
+    # The full name of the exchange.
+    name: str
+
+    # The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
+    timezone: str
+
+    # The time when the exchange opens for trading.
+    start_time: str
+
+    # The time when the exchange closes for trading.
+    close_time: str
+
+    # The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
+    suffix: typing.Optional[str]
+
+class Exchange(RequiredExchange, OptionalExchange):
+    pass

snaptrade_client/type/exchange_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
+
+
+ExchangeID = str

snaptrade_client/type/exchange_rate_pairs.py

@@ -0,0 +1,31 @@
+# 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 RequiredExchangeRatePairs(TypedDict):
+    pass
+
+class OptionalExchangeRatePairs(TypedDict, total=False):
+    src: Currency
+
+    dst: Currency
+
+    exchange_rate: typing.Union[int, float]
+
+class ExchangeRatePairs(RequiredExchangeRatePairs, OptionalExchangeRatePairs):
+    pass

snaptrade_client/type/figi_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 RequiredFigiInstrument(TypedDict):
+    pass
+
+class OptionalFigiInstrument(TypedDict, total=False):
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
+    figi_code: typing.Optional[str]
+
+    # This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
+    figi_share_class: typing.Optional[str]
+
+class FigiInstrument(RequiredFigiInstrument, OptionalFigiInstrument):
+    pass

snaptrade_client/type/figi_instrument_nullable.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 RequiredFigiInstrumentNullable(TypedDict):
+    pass
+
+class OptionalFigiInstrumentNullable(TypedDict, total=False):
+    # This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
+    figi_code: typing.Optional[str]
+
+    # This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
+    figi_share_class: typing.Optional[str]
+
+class FigiInstrumentNullable(RequiredFigiInstrumentNullable, OptionalFigiInstrumentNullable):
+    pass

snaptrade_client/type/holdings_status.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.holdings_sync_status_date_nullable import HoldingsSyncStatusDateNullable
+
+class RequiredHoldingsStatus(TypedDict):
+    pass
+
+class OptionalHoldingsStatus(TypedDict, total=False):
+    # Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
+    initial_sync_completed: bool
+
+    last_successful_sync: HoldingsSyncStatusDateNullable
+
+class HoldingsStatus(RequiredHoldingsStatus, OptionalHoldingsStatus):
+    pass

snaptrade_client/type/holdings_sync_status_date.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
+
+
+HoldingsSyncStatusDate = datetime

snaptrade_client/type/holdings_sync_status_date_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
+
+
+HoldingsSyncStatusDateNullable = datetime

snaptrade_client/type/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
+
+
+Id = str

snaptrade_client/type/login_redirect_uri.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 RequiredLoginRedirectURI(TypedDict):
+    pass
+
+class OptionalLoginRedirectURI(TypedDict, total=False):
+    # Connection Portal link to redirect user to connect a brokerage account.
+    redirectURI: str
+
+    # ID to identify the connection portal session.
+    sessionId: str
+
+class LoginRedirectURI(RequiredLoginRedirectURI, OptionalLoginRedirectURI):
+    pass

snaptrade_client/type/manual_trade.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.action_strict import ActionStrict
+from snaptrade_client.type.manual_trade_symbol import ManualTradeSymbol
+from snaptrade_client.type.order_type_strict import OrderTypeStrict
+from snaptrade_client.type.price import Price
+from snaptrade_client.type.time_in_force_strict import TimeInForceStrict
+from snaptrade_client.type.units_nullable import UnitsNullable
+
+class RequiredManualTrade(TypedDict):
+    pass
+
+class OptionalManualTrade(TypedDict, total=False):
+    # Unique identifier for the submitted order through SnapTrade.
+    id: str
+
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    account: str
+
+    order_type: OrderTypeStrict
+
+    time_in_force: TimeInForceStrict
+
+    symbol: ManualTradeSymbol
+
+    action: ActionStrict
+
+    units: UnitsNullable
+
+    price: Price
+
+class ManualTrade(RequiredManualTrade, OptionalManualTrade):
+    pass

snaptrade_client/type/manual_trade_and_impact.py

@@ -0,0 +1,34 @@
+# 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.manual_trade import ManualTrade
+from snaptrade_client.type.manual_trade_balance import ManualTradeBalance
+from snaptrade_client.type.manual_trade_impact import ManualTradeImpact
+
+class RequiredManualTradeAndImpact(TypedDict):
+    pass
+
+class OptionalManualTradeAndImpact(TypedDict, total=False):
+    trade: ManualTrade
+
+    # List of impacts of the trade on the account. The list always contains one value at the moment.
+    trade_impacts: typing.List[ManualTradeImpact]
+
+    combined_remaining_balance: ManualTradeBalance
+
+class ManualTradeAndImpact(RequiredManualTradeAndImpact, OptionalManualTradeAndImpact):
+    pass

snaptrade_client/type/manual_trade_balance.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.account_simple import AccountSimple
+from snaptrade_client.type.currency import Currency
+
+class RequiredManualTradeBalance(TypedDict):
+    pass
+
+class OptionalManualTradeBalance(TypedDict, total=False):
+    account: AccountSimple
+
+    currency: Currency
+
+    # Estimated amount of cash remaining in the account after the trade. At the moment this is the same as `remaining_cash` under `trade_impacts`.
+    cash: typing.Optional[typing.Union[int, float]]
+
+class ManualTradeBalance(RequiredManualTradeBalance, OptionalManualTradeBalance):
+    pass

snaptrade_client/type/manual_trade_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.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.units_nullable import UnitsNullable
+
+class RequiredManualTradeForm(TypedDict):
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    account_id: str
+
+    action: ActionStrict
+
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    universal_symbol_id: str
+
+    order_type: OrderTypeStrict
+
+    time_in_force: TimeInForceStrict
+
+
+class OptionalManualTradeForm(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]]
+
+    units: UnitsNullable
+
+    notional_value: typing.Optional[NotionalValueNullable]
+
+class ManualTradeForm(RequiredManualTradeForm, OptionalManualTradeForm):
+    pass