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

snaptrade_client/type/model404_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 RequiredModel404FailedRequestResponse(TypedDict):
+    pass
+
+class OptionalModel404FailedRequestResponse(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 Model404FailedRequestResponse(RequiredModel404FailedRequestResponse, OptionalModel404FailedRequestResponse):
+    pass

snaptrade_client/type/model425_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 RequiredModel425FailedRequestResponse(TypedDict):
+    pass
+
+class OptionalModel425FailedRequestResponse(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 Model425FailedRequestResponse(RequiredModel425FailedRequestResponse, OptionalModel425FailedRequestResponse):
+    pass

snaptrade_client/type/model500_unexpected_exception_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
+
+
+class RequiredModel500UnexpectedExceptionResponse(TypedDict):
+    pass
+
+class OptionalModel500UnexpectedExceptionResponse(TypedDict, total=False):
+    detail: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    status_code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+    code: typing.Union[bool, date, datetime, dict, float, int, list, str, None]
+
+class Model500UnexpectedExceptionResponse(RequiredModel500UnexpectedExceptionResponse, OptionalModel500UnexpectedExceptionResponse):
+    pass

snaptrade_client/type/monthly_dividends.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.dividend_at_date import DividendAtDate
+
+class RequiredMonthlyDividends(TypedDict):
+    pass
+
+class OptionalMonthlyDividends(TypedDict, total=False):
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
+    date: date
+
+    dividends: typing.List[DividendAtDate]
+
+class MonthlyDividends(RequiredMonthlyDividends, OptionalMonthlyDividends):
+    pass

snaptrade_client/type/net_contributions.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
+
+
+class RequiredNetContributions(TypedDict):
+    pass
+
+class OptionalNetContributions(TypedDict, total=False):
+    # Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
+    date: date
+
+    contributions: typing.Optional[typing.Union[int, float]]
+
+    currency: str
+
+class NetContributions(RequiredNetContributions, OptionalNetContributions):
+    pass

snaptrade_client/type/net_dividend.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.universal_symbol import UniversalSymbol
+
+class RequiredNetDividend(TypedDict):
+    pass
+
+class OptionalNetDividend(TypedDict, total=False):
+    symbol: UniversalSymbol
+
+    amount: typing.Optional[typing.Union[int, float]]
+
+    currency: str
+
+class NetDividend(RequiredNetDividend, OptionalNetDividend):
+    pass

snaptrade_client/type/notional_value.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
+
+
+NotionalValue = typing.Union[str,typing.Union[int, float]]

snaptrade_client/type/notional_value_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
+
+
+NotionalValueNullable = typing.Union[str,typing.Union[int, float]]

snaptrade_client/type/option_brokerage_symbol.py

@@ -0,0 +1,35 @@
+# 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.options_symbol import OptionsSymbol
+
+class RequiredOptionBrokerageSymbol(TypedDict):
+    pass
+
+class OptionalOptionBrokerageSymbol(TypedDict, total=False):
+    option_symbol: OptionsSymbol
+
+    # 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.
+    id: str
+
+    # WARNING: This property is deprecated
+    # This field is deprecated and the caller should use the `option_symbol` child property's `description` instead.
+    description: str
+
+class OptionBrokerageSymbol(RequiredOptionBrokerageSymbol, OptionalOptionBrokerageSymbol):
+    pass

snaptrade_client/type/option_chain.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.option_chain_item import OptionChainItem
+
+OptionChain = typing.List[OptionChainItem]

snaptrade_client/type/option_chain_item.py

@@ -0,0 +1,35 @@
+# 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_chain_item_chain_per_root import OptionChainItemChainPerRoot
+
+class RequiredOptionChainItem(TypedDict):
+    pass
+
+class OptionalOptionChainItem(TypedDict, total=False):
+    expiryDate: str
+
+    description: str
+
+    listingExchange: str
+
+    optionExerciseType: str
+
+    chainPerRoot: OptionChainItemChainPerRoot
+
+class OptionChainItem(RequiredOptionChainItem, OptionalOptionChainItem):
+    pass

snaptrade_client/type/option_chain_item_chain_per_root.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.option_chain_item_chain_per_root_item import OptionChainItemChainPerRootItem
+
+OptionChainItemChainPerRoot = typing.List[OptionChainItemChainPerRootItem]

snaptrade_client/type/option_chain_item_chain_per_root_item.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.option_chain_item_chain_per_root_item_chain_per_strike_price import OptionChainItemChainPerRootItemChainPerStrikePrice
+
+class RequiredOptionChainItemChainPerRootItem(TypedDict):
+    pass
+
+class OptionalOptionChainItemChainPerRootItem(TypedDict, total=False):
+    optionRoot: str
+
+    chainPerStrikePrice: OptionChainItemChainPerRootItemChainPerStrikePrice
+
+    multiplier: int
+
+class OptionChainItemChainPerRootItem(RequiredOptionChainItemChainPerRootItem, OptionalOptionChainItemChainPerRootItem):
+    pass

snaptrade_client/type/option_chain_item_chain_per_root_item_chain_per_strike_price.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.option_chain_item_chain_per_root_item_chain_per_strike_price_item import OptionChainItemChainPerRootItemChainPerStrikePriceItem
+
+OptionChainItemChainPerRootItemChainPerStrikePrice = typing.List[OptionChainItemChainPerRootItemChainPerStrikePriceItem]

snaptrade_client/type/option_chain_item_chain_per_root_item_chain_per_strike_price_item.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 RequiredOptionChainItemChainPerRootItemChainPerStrikePriceItem(TypedDict):
+    pass
+
+class OptionalOptionChainItemChainPerRootItemChainPerStrikePriceItem(TypedDict, total=False):
+    strikePrice: typing.Optional[int]
+
+    callSymbolId: typing.Optional[int]
+
+    putSymbolId: typing.Optional[int]
+
+class OptionChainItemChainPerRootItemChainPerStrikePriceItem(RequiredOptionChainItemChainPerRootItemChainPerStrikePriceItem, OptionalOptionChainItemChainPerRootItemChainPerStrikePriceItem):
+    pass

snaptrade_client/type/option_leg.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
+
+
+class RequiredOptionLeg(TypedDict):
+    pass
+
+class OptionalOptionLeg(TypedDict, total=False):
+    action: str
+
+    # Obtained from calling options chain endpoint (option_id)
+    option_symbol_id: str
+
+    quantity: typing.Union[int, float]
+
+class OptionLeg(RequiredOptionLeg, OptionalOptionLeg):
+    pass

snaptrade_client/type/option_strategy.py

@@ -0,0 +1,36 @@
+# 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_legs import OptionStrategyLegs
+from snaptrade_client.type.universal_symbol import UniversalSymbol
+
+class RequiredOptionStrategy(TypedDict):
+    pass
+
+class OptionalOptionStrategy(TypedDict, total=False):
+    id: str
+
+    underlying_symbol_id: UniversalSymbol
+
+    strategy_type: str
+
+    number_of_legs: typing.Union[int, float]
+
+    legs: OptionStrategyLegs
+
+class OptionStrategy(RequiredOptionStrategy, OptionalOptionStrategy):
+    pass

snaptrade_client/type/option_strategy_legs.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
+
+
+OptionStrategyLegs = typing.List[typing.Union[bool, date, datetime, dict, float, int, list, str, None]]

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

snaptrade_client/type/options_position.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.currency_nullable import CurrencyNullable
+from snaptrade_client.type.option_brokerage_symbol import OptionBrokerageSymbol
+
+class RequiredOptionsPosition(TypedDict):
+    pass
+
+class OptionalOptionsPosition(TypedDict, total=False):
+    symbol: OptionBrokerageSymbol
+
+    # Last known market price _per share_ of the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
+    price: typing.Optional[typing.Union[int, float]]
+
+    # The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
+    units: typing.Union[int, float]
+
+    # Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100).
+    average_purchase_price: typing.Optional[typing.Union[int, float]]
+
+    currency: typing.Optional[CurrencyNullable]
+
+class OptionsPosition(RequiredOptionsPosition, OptionalOptionsPosition):
+    pass

snaptrade_client/type/options_symbol.py

@@ -0,0 +1,44 @@
+# 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.underlying_symbol import UnderlyingSymbol
+
+class RequiredOptionsSymbol(TypedDict):
+    # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    id: str
+
+    # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
+    ticker: str
+
+    # The type of option. Either \"CALL\" or \"PUT\".
+    option_type: str
+
+    # The option strike price.
+    strike_price: typing.Union[int, float]
+
+    # The option expiration date.
+    expiration_date: date
+
+    underlying_symbol: UnderlyingSymbol
+
+
+class OptionalOptionsSymbol(TypedDict, total=False):
+    # Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
+    is_mini_option: bool
+
+class OptionsSymbol(RequiredOptionsSymbol, OptionalOptionsSymbol):
+    pass

snaptrade_client/type/options_symbol_nullable.py

@@ -0,0 +1,44 @@
+# 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.underlying_symbol import UnderlyingSymbol
+
+class RequiredOptionsSymbolNullable(TypedDict):
+    # Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+    id: str
+
+    # The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
+    ticker: str
+
+    # The type of option. Either \"CALL\" or \"PUT\".
+    option_type: str
+
+    # The option strike price.
+    strike_price: typing.Union[int, float]
+
+    # The option expiration date.
+    expiration_date: date
+
+    underlying_symbol: UnderlyingSymbol
+
+
+class OptionalOptionsSymbolNullable(TypedDict, total=False):
+    # Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
+    is_mini_option: bool
+
+class OptionsSymbolNullable(RequiredOptionsSymbolNullable, OptionalOptionsSymbolNullable):
+    pass

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