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

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

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

snaptrade_client/type/brokerage_instrument.py

@@ -0,0 +1,38 @@
+# 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 RequiredBrokerageInstrument(TypedDict):
+    # The instrument's trading symbol / ticker.
+    symbol: str
+
+
+class OptionalBrokerageInstrument(TypedDict, total=False):
+    # The MIC code of the exchange where the instrument is traded.
+    exchange_mic: typing.Optional[str]
+
+    # Whether the instrument is tradeable through the brokerage. `null` if the tradeability is unknown.
+    tradeable: typing.Optional[bool]
+
+    # Whether the instrument allows fractional units. `null` if the fractionability is unknown.
+    fractionable: typing.Optional[bool]
+
+    # The universal symbol ID of the instrument. This is the ID used to reference the instrument in SnapTrade API calls.
+    universal_symbol_id: typing.Optional[str]
+
+class BrokerageInstrument(RequiredBrokerageInstrument, OptionalBrokerageInstrument):
+    pass

snaptrade_client/type/brokerage_instruments_response.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
+
+from snaptrade_client.type.brokerage_instrument import BrokerageInstrument
+
+class RequiredBrokerageInstrumentsResponse(TypedDict):
+    pass
+
+class OptionalBrokerageInstrumentsResponse(TypedDict, total=False):
+    instruments: typing.List[BrokerageInstrument]
+
+class BrokerageInstrumentsResponse(RequiredBrokerageInstrumentsResponse, OptionalBrokerageInstrumentsResponse):
+    pass

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

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

snaptrade_client/type/brokerage_type.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 RequiredBrokerageType(TypedDict):
+    pass
+
+class OptionalBrokerageType(TypedDict, total=False):
+    id: str
+
+    name: str
+
+class BrokerageType(RequiredBrokerageType, OptionalBrokerageType):
+    pass

snaptrade_client/type/cancel_order_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.cancel_order_response_raw_response import CancelOrderResponseRawResponse
+
+class RequiredCancelOrderResponse(TypedDict):
+    # Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
+    brokerage_order_id: str
+
+
+class OptionalCancelOrderResponse(TypedDict, total=False):
+    raw_response: typing.Optional[CancelOrderResponseRawResponse]
+
+class CancelOrderResponse(RequiredCancelOrderResponse, OptionalCancelOrderResponse):
+    pass

snaptrade_client/type/cancel_order_response_raw_response.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
+
+
+CancelOrderResponseRawResponse = dict

snaptrade_client/type/child_brokerage_order_ids.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 RequiredChildBrokerageOrderIDs(TypedDict):
+    pass
+
+class OptionalChildBrokerageOrderIDs(TypedDict, total=False):
+    # The brokerage order ID for the take profit leg of the bracket order
+    take_profit_order_id: str
+
+    # The brokerage order ID for the stop loss leg of the bracket order
+    stop_loss_order_id: str
+
+class ChildBrokerageOrderIDs(RequiredChildBrokerageOrderIDs, OptionalChildBrokerageOrderIDs):
+    pass

snaptrade_client/type/child_brokerage_order_ids_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 RequiredChildBrokerageOrderIDsNullable(TypedDict):
+    pass
+
+class OptionalChildBrokerageOrderIDsNullable(TypedDict, total=False):
+    # The brokerage order ID for the take profit leg of the bracket order
+    take_profit_order_id: str
+
+    # The brokerage order ID for the stop loss leg of the bracket order
+    stop_loss_order_id: str
+
+class ChildBrokerageOrderIDsNullable(RequiredChildBrokerageOrderIDsNullable, OptionalChildBrokerageOrderIDsNullable):
+    pass

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

snaptrade_client/type/crypto_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.crypto_trading_instrument import CryptoTradingInstrument
+
+class RequiredCryptoOrderForm(TypedDict):
+    instrument: CryptoTradingInstrument
+
+    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 OptionalCryptoOrderForm(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 CryptoOrderForm(RequiredCryptoOrderForm, OptionalCryptoOrderForm):
+    pass

snaptrade_client/type/crypto_order_preview.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
+
+from snaptrade_client.type.crypto_order_preview_estimated_fee import CryptoOrderPreviewEstimatedFee
+
+class RequiredCryptoOrderPreview(TypedDict):
+    pass
+
+class OptionalCryptoOrderPreview(TypedDict, total=False):
+    estimated_fee: CryptoOrderPreviewEstimatedFee
+
+class CryptoOrderPreview(RequiredCryptoOrderPreview, OptionalCryptoOrderPreview):
+    pass

snaptrade_client/type/crypto_order_preview_estimated_fee.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
+
+
+class RequiredCryptoOrderPreviewEstimatedFee(TypedDict):
+    # Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes.
+    currency: str
+
+    amount: str
+
+class OptionalCryptoOrderPreviewEstimatedFee(TypedDict, total=False):
+    pass
+
+class CryptoOrderPreviewEstimatedFee(RequiredCryptoOrderPreviewEstimatedFee, OptionalCryptoOrderPreviewEstimatedFee):
+    pass

snaptrade_client/type/crypto_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 RequiredCryptoTradingInstrument(TypedDict):
+    # The instrument's trading ticker symbol
+    symbol: str
+
+    # The instrument's type
+    type: str
+
+class OptionalCryptoTradingInstrument(TypedDict, total=False):
+    pass
+
+class CryptoTradingInstrument(RequiredCryptoTradingInstrument, OptionalCryptoTradingInstrument):
+    pass

snaptrade_client/type/cryptocurrency_base_symbol.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
+
+
+CryptocurrencyBaseSymbol = str

snaptrade_client/type/cryptocurrency_increment.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
+
+
+CryptocurrencyIncrement = str

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

snaptrade_client/type/cryptocurrency_pair.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.cryptocurrency_increment_nullable import CryptocurrencyIncrementNullable
+
+class RequiredCryptocurrencyPair(TypedDict):
+    # The base currency of a pair (e.g., \"BTC\" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes. 
+    base: str
+
+    # The quote currency of a pair (e.g., \"USD\" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes. 
+    quote: str
+
+
+class OptionalCryptocurrencyPair(TypedDict, total=False):
+    # Cryptocurrency pair instrument symbol
+    symbol: str
+
+    increment: CryptocurrencyIncrementNullable
+
+class CryptocurrencyPair(RequiredCryptocurrencyPair, OptionalCryptocurrencyPair):
+    pass

snaptrade_client/type/cryptocurrency_pair_quote.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
+
+
+class RequiredCryptocurrencyPairQuote(TypedDict):
+    # The highest price a buyer is willing to pay.
+    bid: str
+
+    # The lowest price a seller is willing to accept.
+    ask: str
+
+
+class OptionalCryptocurrencyPairQuote(TypedDict, total=False):
+    # The market mid price.
+    mid: str
+
+    # The timestamp of the quote.
+    timestamp: datetime
+
+class CryptocurrencyPairQuote(RequiredCryptocurrencyPairQuote, OptionalCryptocurrencyPairQuote):
+    pass

snaptrade_client/type/cryptocurrency_pair_symbol.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
+
+
+CryptocurrencyPairSymbol = str

snaptrade_client/type/cryptocurrency_quote_symbol.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
+
+
+CryptocurrencyQuoteSymbol = str

snaptrade_client/type/cryptocurrency_symbol.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
+
+
+CryptocurrencySymbol = str

snaptrade_client/type/currency.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 RequiredCurrency(TypedDict):
+    pass
+
+class OptionalCurrency(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 Currency(RequiredCurrency, OptionalCurrency):
+    pass