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

snaptrade_client/type/order_type_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
+
+
+OrderTypeStrict = Literal["Limit", "Market", "StopLimit", "Stop"]

snaptrade_client/type/order_updated_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.account_order_record import AccountOrderRecord
+
+class RequiredOrderUpdatedResponse(TypedDict):
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    brokerage_order_id: str
+
+
+class OptionalOrderUpdatedResponse(TypedDict, total=False):
+    order: AccountOrderRecord
+
+class OrderUpdatedResponse(RequiredOrderUpdatedResponse, OptionalOrderUpdatedResponse):
+    pass

snaptrade_client/type/paginated_universal_activity.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.account_universal_activity import AccountUniversalActivity
+from snaptrade_client.type.pagination_details import PaginationDetails
+
+class RequiredPaginatedUniversalActivity(TypedDict):
+    pass
+
+class OptionalPaginatedUniversalActivity(TypedDict, total=False):
+    data: typing.List[AccountUniversalActivity]
+
+    pagination: PaginationDetails
+
+class PaginatedUniversalActivity(RequiredPaginatedUniversalActivity, OptionalPaginatedUniversalActivity):
+    pass

snaptrade_client/type/pagination_details.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 RequiredPaginationDetails(TypedDict):
+    pass
+
+class OptionalPaginationDetails(TypedDict, total=False):
+    # The starting point of the paginated results.
+    offset: int
+
+    # The maximum number of items to return in the response.
+    limit: int
+
+    # The total number of items available to be returned over the API.
+    total: int
+
+class PaginationDetails(RequiredPaginationDetails, OptionalPaginationDetails):
+    pass

snaptrade_client/type/partner_data.py

@@ -0,0 +1,62 @@
+# 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.brokerage import Brokerage
+
+class RequiredPartnerData(TypedDict):
+    pass
+
+class OptionalPartnerData(TypedDict, total=False):
+    # A short, unique identifier for your company or product.
+    slug: str
+
+    # Your company or product name.
+    name: str
+
+    # URL to your company or product logo.
+    logo_url: str
+
+    # Brokerages that can be accessed by your Client ID.
+    allowed_brokerages: typing.List[Brokerage]
+
+    # Whether trading is enabled for your SnapTrade Client ID.
+    can_access_trades: bool
+
+    # Whether holdings data is enabled for your SnapTrade Client ID.
+    can_access_holdings: bool
+
+    # Whether account historical transactions is enabled for your SnapTrade Client ID.
+    can_access_account_history: bool
+
+    # Whether reference data is enabled for your SnapTrade Client ID.
+    can_access_reference_data: bool
+
+    # Whether portfolio management is enabled for your SnapTrade Client ID.
+    can_access_portfolio_management: bool
+
+    # Whether recent order history is enabled for your SnapTrade Client ID.
+    can_access_orders: bool
+
+    # URI to redirect user back to after user is done adding brokerage connections.
+    redirect_uri: str
+
+    # WARNING: This property is deprecated
+    # Shows if pin is required by users to access connection page. This field has been deprecated.
+    pin_required: bool
+
+class PartnerData(RequiredPartnerData, OptionalPartnerData):
+    pass

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

snaptrade_client/type/performance_custom.py

@@ -0,0 +1,78 @@
+# 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.monthly_dividends import MonthlyDividends
+from snaptrade_client.type.net_contributions import NetContributions
+from snaptrade_client.type.net_dividend import NetDividend
+from snaptrade_client.type.past_value import PastValue
+from snaptrade_client.type.performance_custom_bad_tickers import PerformanceCustomBadTickers
+from snaptrade_client.type.sub_period_return_rate import SubPeriodReturnRate
+
+class RequiredPerformanceCustom(TypedDict):
+    pass
+
+class OptionalPerformanceCustom(TypedDict, total=False):
+    totalEquityTimeframe: typing.List[PastValue]
+
+    contributions: NetContributions
+
+    contributionTimeframe: typing.List[PastValue]
+
+    contributionTimeframeCumulative: typing.List[PastValue]
+
+    withdrawalTimeframe: typing.List[PastValue]
+
+    # Current streak of cosecutive months where contributions were made
+    contributionStreak: typing.Optional[typing.Union[int, float]]
+
+    # Number of months in the timeframe with contributions
+    contributionMonthsContributed: typing.Optional[typing.Union[int, float]]
+
+    # Total months in timeframe
+    contributionTotalMonths: typing.Optional[typing.Union[int, float]]
+
+    dividends: typing.List[NetDividend]
+
+    # Total dividends received over the timeframe
+    dividendIncome: typing.Optional[typing.Union[int, float]]
+
+    # Average dividends received per month over the timeframe
+    monthlyDividends: typing.Optional[typing.Union[int, float]]
+
+    badTickers: PerformanceCustomBadTickers
+
+    dividendTimeline: typing.List[MonthlyDividends]
+
+    # commissions incurred during the timeframe
+    commissions: typing.Optional[typing.Union[int, float]]
+
+    # forex fees incurred during the timeframe
+    forexFees: typing.Optional[typing.Union[int, float]]
+
+    # other fees incurred during the timeframe
+    fees: typing.Optional[typing.Union[int, float]]
+
+    # The return rate over the timeframe. Annualized if timeframe is longer than 1 year
+    rateOfReturn: typing.Optional[typing.Union[int, float]]
+
+    returnRateTimeframe: typing.List[SubPeriodReturnRate]
+
+    # Whether the user has detailed mode enabled (more frequent data points for totalEquity and contribution timeframes)
+    detailedMode: bool
+
+class PerformanceCustom(RequiredPerformanceCustom, OptionalPerformanceCustom):
+    pass

snaptrade_client/type/performance_custom_bad_tickers.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
+
+
+PerformanceCustomBadTickers = typing.List[typing.Optional[str]]

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

snaptrade_client/type/position.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.currency import Currency
+from snaptrade_client.type.position_symbol import PositionSymbol
+
+class RequiredPosition(TypedDict):
+    pass
+
+class OptionalPosition(TypedDict, total=False):
+    symbol: PositionSymbol
+
+    # The number of shares of the position. This can be fractional or integer units.
+    units: typing.Optional[typing.Union[int, float]]
+
+    # Last known market price for the symbol. 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 profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.
+    open_pnl: typing.Optional[typing.Union[int, float]]
+
+    # Cost basis _per share_ of this position.
+    average_purchase_price: typing.Optional[typing.Union[int, float]]
+
+    # WARNING: This property is deprecated
+    # Deprecated, use the `units` field for both fractional and integer units going forward
+    fractional_units: typing.Optional[typing.Union[int, float]]
+
+    # The 'position currency' (`price` and `average_purchase_price`). This currency can potentially be different from the 'listing currency' of the security. The 'listing currency' is what's quoted on the listing exchange, while the 'position currency' is what the brokerage uses to hold and value your position. 
+    currency: Currency
+
+    # If the position is a cash equivalent (usually a money market fund) that is also counted in account cash balance and buying power
+    cash_equivalent: typing.Optional[bool]
+
+class Position(RequiredPosition, OptionalPosition):
+    pass

snaptrade_client/type/position_symbol.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.universal_symbol import UniversalSymbol
+
+class RequiredPositionSymbol(TypedDict):
+    pass
+
+class OptionalPositionSymbol(TypedDict, total=False):
+    symbol: UniversalSymbol
+
+    # 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 `symbol` child property's `description` instead.
+    description: str
+
+    # 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.
+    local_id: typing.Optional[str]
+
+    # 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.
+    is_quotable: bool
+
+    # 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.
+    is_tradable: bool
+
+class PositionSymbol(RequiredPositionSymbol, OptionalPositionSymbol):
+    pass

snaptrade_client/type/price.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
+
+
+Price = float

snaptrade_client/type/rate_of_return_object.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 RequiredRateOfReturnObject(TypedDict):
+    pass
+
+class OptionalRateOfReturnObject(TypedDict, total=False):
+    # The timeframe this return percent is reflecting
+    timeframe: str
+
+    # The percent return of the portfolio, directly from the brokerage. 5.97 indicates a 5.97% return over the timeframe
+    return_percent: typing.Union[int, float]
+
+    # The date this was fetched
+    created_date: datetime
+
+class RateOfReturnObject(RequiredRateOfReturnObject, OptionalRateOfReturnObject):
+    pass

snaptrade_client/type/rate_of_return_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
+
+from snaptrade_client.type.rate_of_return_object import RateOfReturnObject
+
+class RequiredRateOfReturnResponse(TypedDict):
+    pass
+
+class OptionalRateOfReturnResponse(TypedDict, total=False):
+    # List of return percentages
+    data: typing.List[RateOfReturnObject]
+
+class RateOfReturnResponse(RequiredRateOfReturnResponse, OptionalRateOfReturnResponse):
+    pass

snaptrade_client/type/recent_orders_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
+
+from snaptrade_client.type.account_order_record import AccountOrderRecord
+
+class RequiredRecentOrdersResponse(TypedDict):
+    pass
+
+class OptionalRecentOrdersResponse(TypedDict, total=False):
+    # List of orders executed in the last 24 hours
+    orders: typing.List[AccountOrderRecord]
+
+class RecentOrdersResponse(RequiredRecentOrdersResponse, OptionalRecentOrdersResponse):
+    pass

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

snaptrade_client/type/reporting_frequency.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
+
+
+ReportingFrequency = str

snaptrade_client/type/security_type.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
+
+
+class RequiredSecurityType(TypedDict):
+    pass
+
+class OptionalSecurityType(TypedDict, total=False):
+    # Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
+    id: str
+
+    # A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   - `ad` - ADR   - `bnd` - Bond   - `cs` - Common Stock   - `cef` - Closed End Fund   - `crypto` - Cryptocurrency   - `et` - ETF   - `oef` - Open Ended Fund   - `pm` - Precious Metals   - `ps` - Preferred Stock   - `rt` - Right   - `struct` - Structured Product   - `ut` - Unit   - `wi` - When Issued   - `wt` - Warrant 
+    code: str
+
+    # A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
+    description: str
+
+    # 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.
+    is_supported: bool
+
+class SecurityType(RequiredSecurityType, OptionalSecurityType):
+    pass

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

snaptrade_client/type/session_event.py

@@ -0,0 +1,40 @@
+# 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 RequiredSessionEvent(TypedDict):
+    pass
+
+class OptionalSessionEvent(TypedDict, total=False):
+    id: str
+
+    session_event_type: str
+
+    session_id: 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.
+    user_id: str
+
+    # Time
+    created_date: str
+
+    brokerage_status_code: typing.Optional[int]
+
+    brokerage_authorization_id: str
+
+class SessionEvent(RequiredSessionEvent, OptionalSessionEvent):
+    pass