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

snaptrade_client/type/simple_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.trading_instrument import TradingInstrument
+
+class RequiredSimpleOrderForm(TypedDict):
+    instrument: TradingInstrument
+
+    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 OptionalSimpleOrderForm(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 SimpleOrderForm(RequiredSimpleOrderForm, OptionalSimpleOrderForm):
+    pass

snaptrade_client/type/snap_trade_holdings_account.py

@@ -0,0 +1,43 @@
+# 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_sync_status import AccountSyncStatus
+from snaptrade_client.type.brokerage_authorization import BrokerageAuthorization
+from snaptrade_client.type.snap_trade_holdings_account_meta import SnapTradeHoldingsAccountMeta
+
+class RequiredSnapTradeHoldingsAccount(TypedDict):
+    pass
+
+class OptionalSnapTradeHoldingsAccount(TypedDict, total=False):
+    id: str
+
+    brokerage_authorization: BrokerageAuthorization
+
+    portfolio_group: str
+
+    name: typing.Optional[str]
+
+    number: str
+
+    institution_name: str
+
+    sync_status: AccountSyncStatus
+
+    meta: SnapTradeHoldingsAccountMeta
+
+class SnapTradeHoldingsAccount(RequiredSnapTradeHoldingsAccount, OptionalSnapTradeHoldingsAccount):
+    pass

snaptrade_client/type/snap_trade_holdings_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
+
+
+SnapTradeHoldingsAccountMeta = dict

snaptrade_client/type/snap_trade_holdings_total_value.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 RequiredSnapTradeHoldingsTotalValue(TypedDict):
+    pass
+
+class OptionalSnapTradeHoldingsTotalValue(TypedDict, total=False):
+    # Total value denominated in the currency of the `currency` field.
+    value: typing.Optional[typing.Union[int, float]]
+
+    # The ISO-4217 currency code for the amount.
+    currency: typing.Optional[str]
+
+class SnapTradeHoldingsTotalValue(RequiredSnapTradeHoldingsTotalValue, OptionalSnapTradeHoldingsTotalValue):
+    pass

snaptrade_client/type/snap_trade_login_user_request_body.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 RequiredSnapTradeLoginUserRequestBody(TypedDict):
+    pass
+
+class OptionalSnapTradeLoginUserRequestBody(TypedDict, total=False):
+    # Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
+    broker: str
+
+    # When set to `true`, user will be redirected back to the partner's site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
+    immediateRedirect: bool
+
+    # URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
+    customRedirect: str
+
+    # The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
+    reconnect: str
+
+    # Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically. 
+    connectionType: str
+
+    # Controls whether the close (X) button is displayed in the connection portal. When false, you control closing behavior from your app. Defaults to true.
+    showCloseButton: bool
+
+    # Enable dark mode for the connection portal. Defaults to false.
+    darkMode: bool
+
+    # Sets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4.
+    connectionPortalVersion: str
+
+class SnapTradeLoginUserRequestBody(RequiredSnapTradeLoginUserRequestBody, OptionalSnapTradeLoginUserRequestBody):
+    pass

snaptrade_client/type/snap_trade_register_user_request_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 RequiredSnapTradeRegisterUserRequestBody(TypedDict):
+    # 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 OptionalSnapTradeRegisterUserRequestBody(TypedDict, total=False):
+    pass
+
+class SnapTradeRegisterUserRequestBody(RequiredSnapTradeRegisterUserRequestBody, OptionalSnapTradeRegisterUserRequestBody):
+    pass

snaptrade_client/type/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
+
+
+class RequiredStatus(TypedDict):
+    pass
+
+class OptionalStatus(TypedDict, total=False):
+    version: int
+
+    timestamp: str
+
+    online: bool
+
+class Status(RequiredStatus, OptionalStatus):
+    pass

snaptrade_client/type/stop_loss.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 RequiredStopLoss(TypedDict):
+    pass
+
+class OptionalStopLoss(TypedDict, total=False):
+    stop_price: str
+
+    limit_price: typing.Optional[str]
+
+class StopLoss(RequiredStopLoss, OptionalStopLoss):
+    pass

snaptrade_client/type/strategy_order_record.py

@@ -0,0 +1,52 @@
+# 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.option_strategy import OptionStrategy
+from snaptrade_client.type.order_type import OrderType
+from snaptrade_client.type.price import Price
+
+class RequiredStrategyOrderRecord(TypedDict):
+    pass
+
+class OptionalStrategyOrderRecord(TypedDict, total=False):
+    strategy: OptionStrategy
+
+    status: str
+
+    filled_quantity: typing.Union[int, float]
+
+    open_quantity: typing.Union[int, float]
+
+    closed_quantity: typing.Union[int, float]
+
+    order_type: OrderType
+
+    # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
+    time_in_force: str
+
+    limit_price: Price
+
+    execution_price: Price
+
+    # Time
+    time_placed: str
+
+    # Time
+    time_updated: str
+
+class StrategyOrderRecord(RequiredStrategyOrderRecord, OptionalStrategyOrderRecord):
+    pass

snaptrade_client/type/strategy_quotes.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
+
+from snaptrade_client.type.option_strategy import OptionStrategy
+from snaptrade_client.type.price import Price
+from snaptrade_client.type.strategy_quotes_greek import StrategyQuotesGreek
+
+class RequiredStrategyQuotes(TypedDict):
+    pass
+
+class OptionalStrategyQuotes(TypedDict, total=False):
+    strategy: OptionStrategy
+
+    open_price: Price
+
+    bid_price: Price
+
+    ask_price: Price
+
+    volatility: typing.Union[int, float]
+
+    greek: StrategyQuotesGreek
+
+class StrategyQuotes(RequiredStrategyQuotes, OptionalStrategyQuotes):
+    pass

snaptrade_client/type/strategy_quotes_greek.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
+
+
+class RequiredStrategyQuotesGreek(TypedDict):
+    pass
+
+class OptionalStrategyQuotesGreek(TypedDict, total=False):
+    delta: typing.Union[int, float]
+
+    gamma: typing.Union[int, float]
+
+    theta: typing.Union[int, float]
+
+    vega: typing.Union[int, float]
+
+    rho: typing.Union[int, float]
+
+class StrategyQuotesGreek(RequiredStrategyQuotesGreek, OptionalStrategyQuotesGreek):
+    pass

snaptrade_client/type/sub_period_return_rate.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 RequiredSubPeriodReturnRate(TypedDict):
+    pass
+
+class OptionalSubPeriodReturnRate(TypedDict, total=False):
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
+    periodStart: date
+
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
+    periodEnd: date
+
+    # The return rate for the given period
+    rateOfReturn: typing.Optional[typing.Union[int, float]]
+
+class SubPeriodReturnRate(RequiredSubPeriodReturnRate, OptionalSubPeriodReturnRate):
+    pass

snaptrade_client/type/symbol.py

@@ -0,0 +1,53 @@
+# 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 RequiredSymbol(TypedDict):
+    pass
+
+class OptionalSymbol(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: Exchange
+
+    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]
+
+class Symbol(RequiredSymbol, OptionalSymbol):
+    pass

snaptrade_client/type/symbol_nullable.py

@@ -0,0 +1,53 @@
+# 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 RequiredSymbolNullable(TypedDict):
+    pass
+
+class OptionalSymbolNullable(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: Exchange
+
+    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]
+
+class SymbolNullable(RequiredSymbolNullable, OptionalSymbolNullable):
+    pass

snaptrade_client/type/symbol_query.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 RequiredSymbolQuery(TypedDict):
+    pass
+
+class OptionalSymbolQuery(TypedDict, total=False):
+    # The search query for symbols.
+    substring: str
+
+class SymbolQuery(RequiredSymbolQuery, OptionalSymbolQuery):
+    pass

snaptrade_client/type/symbols_quotes.py

@@ -0,0 +1,20 @@
+# 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.universal_symbol import UniversalSymbol
+
+SymbolsQuotes = typing.List[typing.Union[bool, date, datetime, dict, float, int, list, str, None]]

snaptrade_client/type/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
+
+
+SyncStatusDate = date

snaptrade_client/type/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
+
+
+SyncStatusDateNullable = date

snaptrade_client/type/take_profit.py

@@ -0,0 +1,26 @@
+# 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 RequiredTakeProfit(TypedDict):
+    pass
+
+class OptionalTakeProfit(TypedDict, total=False):
+    limit_price: str
+
+class TakeProfit(RequiredTakeProfit, OptionalTakeProfit):
+    pass