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

snaptrade_client/type/time.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
+
+
+Time = str

snaptrade_client/type/time_in_force.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
+
+
+TimeInForce = str

snaptrade_client/type/time_in_force_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
+
+
+TimeInForceStrict = Literal["FOK", "Day", "GTC", "IOC"]

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

snaptrade_client/type/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 RequiredTradingInstrument(TypedDict):
+    # The instrument'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
+
+    # The instrument's type
+    type: str
+
+class OptionalTradingInstrument(TypedDict, total=False):
+    pass
+
+class TradingInstrument(RequiredTradingInstrument, OptionalTradingInstrument):
+    pass

snaptrade_client/type/trading_session.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
+
+
+TradingSession = Literal["REGULAR", "EXTENDED"]

snaptrade_client/type/transactions_status.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.sync_status_date import SyncStatusDate
+from snaptrade_client.type.sync_status_date_nullable import SyncStatusDateNullable
+
+class RequiredTransactionsStatus(TypedDict):
+    pass
+
+class OptionalTransactionsStatus(TypedDict, total=False):
+    # Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete.
+    initial_sync_completed: bool
+
+    last_successful_sync: SyncStatusDateNullable
+
+    # The date of the first transaction in the account known to SnapTrade. It's possible that the account has transactions before this date, but they are not known to SnapTrade.
+    first_transaction_date: SyncStatusDate
+
+class TransactionsStatus(RequiredTransactionsStatus, OptionalTransactionsStatus):
+    pass

snaptrade_client/type/underlying_symbol.py

@@ -0,0 +1,58 @@
+# 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
+from snaptrade_client.type.figi_instrument_nullable import FigiInstrumentNullable
+from snaptrade_client.type.security_type import SecurityType
+from snaptrade_client.type.us_exchange import USExchange
+
+class RequiredUnderlyingSymbol(TypedDict):
+    pass
+
+class OptionalUnderlyingSymbol(TypedDict, total=False):
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    id: str
+
+    # The security's trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
+    symbol: str
+
+    # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
+    raw_symbol: str
+
+    # A human-readable description of the security. This is usually the company name or ETF name.
+    description: typing.Optional[str]
+
+    # The currency in which the security is traded.
+    currency: Currency
+
+    # The exchange on which the security is listed and traded.
+    exchange: USExchange
+
+    # The type of security. For example, \"Common Stock\" or \"ETF\".
+    type: SecurityType
+
+    # 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
+    figi_code: typing.Optional[str]
+
+    figi_instrument: typing.Optional[FigiInstrumentNullable]
+
+    # WARNING: This property is deprecated
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
+    currencies: typing.List[Currency]
+
+class UnderlyingSymbol(RequiredUnderlyingSymbol, OptionalUnderlyingSymbol):
+    pass

snaptrade_client/type/units.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
+
+
+Units = float

snaptrade_client/type/units_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
+
+
+UnitsNullable = float

snaptrade_client/type/universal_activity.py

@@ -0,0 +1,76 @@
+# 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
+from snaptrade_client.type.options_symbol_nullable import OptionsSymbolNullable
+from snaptrade_client.type.symbol_nullable import SymbolNullable
+
+class RequiredUniversalActivity(TypedDict):
+    pass
+
+class OptionalUniversalActivity(TypedDict, total=False):
+    # Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.  Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one. 
+    id: str
+
+    account: AccountSimple
+
+    symbol: typing.Optional[SymbolNullable]
+
+    option_symbol: typing.Optional[OptionsSymbolNullable]
+
+    # The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
+    price: typing.Union[int, float]
+
+    # The number of units of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
+    units: typing.Union[int, float]
+
+    # The amount of the transaction denominated in `currency`. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount.
+    amount: typing.Optional[typing.Union[int, float]]
+
+    # The currency in which the transaction `price` and `amount` is denominated.
+    currency: Currency
+
+    # A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info.   - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info.   - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info. 
+    type: str
+
+    # If an option `BUY` or `SELL` transaction, this further specifies the type of action. The possible values are: - BUY_TO_OPEN - BUY_TO_CLOSE - SELL_TO_OPEN - SELL_TO_CLOSE 
+    option_type: str
+
+    # A human-readable description of the transaction. This is usually the brokerage's description of the transaction.
+    description: str
+
+    # The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the [integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named `trade_date`, it can represent any type of transaction, not just trades.
+    trade_date: typing.Optional[datetime]
+
+    # The date on which the transaction is settled.
+    settlement_date: datetime
+
+    # Any fee associated with the transaction if provided by the brokerage.
+    fee: typing.Union[int, float]
+
+    # The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency)
+    fx_rate: typing.Optional[typing.Union[int, float]]
+
+    # The institution that the transaction is associated with. This is usually the brokerage name.
+    institution: str
+
+    # Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same `external_reference_id`
+    external_reference_id: typing.Optional[str]
+
+class UniversalActivity(RequiredUniversalActivity, OptionalUniversalActivity):
+    pass

snaptrade_client/type/universal_symbol.py

@@ -0,0 +1,56 @@
+# 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
+from snaptrade_client.type.exchange import Exchange
+from snaptrade_client.type.figi_instrument_nullable import FigiInstrumentNullable
+from snaptrade_client.type.security_type import SecurityType
+
+class RequiredUniversalSymbol(TypedDict):
+    # Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    id: str
+
+    # The security's trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
+    symbol: str
+
+    # The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
+    raw_symbol: str
+
+    # The currency in which the security is traded.
+    currency: Currency
+
+    type: SecurityType
+
+    # WARNING: This property is deprecated
+    # This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.
+    currencies: typing.List[Currency]
+
+
+class OptionalUniversalSymbol(TypedDict, total=False):
+    # A human-readable description of the security. This is usually the company name or ETF name.
+    description: typing.Optional[str]
+
+    # The exchange on which the security is listed and traded.
+    exchange: Exchange
+
+    # 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
+    figi_code: typing.Optional[str]
+
+    figi_instrument: typing.Optional[FigiInstrumentNullable]
+
+class UniversalSymbol(RequiredUniversalSymbol, OptionalUniversalSymbol):
+    pass

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

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

snaptrade_client/type/us_exchange.py

@@ -0,0 +1,42 @@
+# 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 RequiredUSExchange(TypedDict):
+    pass
+
+class OptionalUSExchange(TypedDict, total=False):
+    id: str
+
+    code: str
+
+    mic_code: str
+
+    name: str
+
+    timezone: str
+
+    start_time: str
+
+    close_time: str
+
+    suffix: typing.Optional[str]
+
+    allows_cryptocurrency_symbols: bool
+
+class USExchange(RequiredUSExchange, OptionalUSExchange):
+    pass

snaptrade_client/type/user_i_dand_secret.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 RequiredUserIDandSecret(TypedDict):
+    pass
+
+class OptionalUserIDandSecret(TypedDict, total=False):
+    # 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
+
+    # SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret).
+    userSecret: str
+
+class UserIDandSecret(RequiredUserIDandSecret, OptionalUserIDandSecret):
+    pass

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

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

snaptrade_client/type/user_secret.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
+
+
+UserSecret = str

snaptrade_client/type/validated_trade_body.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 RequiredValidatedTradeBody(TypedDict):
+    pass
+
+class OptionalValidatedTradeBody(TypedDict, total=False):
+    # Optional, defaults to true. Determines if a wait is performed to check on order status. If false, latency will be reduced but orders returned will be more likely to be of status `PENDING` as we will not wait to check on the status before responding to the request.
+    wait_to_confirm: typing.Optional[bool]
+
+class ValidatedTradeBody(RequiredValidatedTradeBody, OptionalValidatedTradeBody):
+    pass

snaptrade_client/type_util.py

@@ -0,0 +1,23 @@
+"""
+    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 typing import Callable, Generic, TypeVar, Any
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+class copy_signature(Generic[F]):
+    def __init__(self, func: F, *args) -> None:
+        self.func = func
+
+    def __call__(self, *args, **kwargs) -> F:
+        if len(args) == 1:
+            return args[0]
+        return self.func(*args, **kwargs)

{snaptrade_python_sdk-10.9.0.dist-info → snaptrade_python_sdk-11.0.152.dist-info}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023- Konfig, Inc. (https://konfigthis.com)
+Copyright (c) 2025- Konfig, Inc. (https://konfigthis.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: