Client for SnapTrade

These details have not been verified by PyPI

Project description

SnapTrade

Connect brokerage accounts to your app for live positions and trading

Requirements
Installation
Getting Started
Async
Reference

Requirements

Python >=3.7

Installation

pip install snaptrade-python-sdk==11.0.29

Getting Started

import os
import uuid
from pprint import pprint
from snaptrade_client import SnapTrade

# 1) Initialize a client with your clientID and consumerKey.
snaptrade = SnapTrade(
    consumer_key=os.environ["SNAPTRADE_CONSUMER_KEY"],
    client_id=os.environ["SNAPTRADE_CLIENT_ID"],
)

# 2) Check that the client is able to make a request to the API server.
api_response = snaptrade.api_status.check()
pprint(api_response.body)

# 3) Create a new user on SnapTrade
user_id = str(uuid.uuid4())
register_response = snaptrade.authentication.register_snap_trade_user(
    body={"userId": user_id}
)
pprint(register_response.body)

# Note: A user secret is only generated once. It's required to access
# resources for certain endpoints.
user_secret = register_response.body["userSecret"]

# 4) Get a redirect URI. Users will need this to connect
# their brokerage to the SnapTrade server.
redirect_uri = snaptrade.authentication.login_snap_trade_user(
    query_params={"userId": user_id, "userSecret": user_secret}
)
print(redirect_uri.body)

# 5) Obtaining account holdings data
holdings = snaptrade.account_information.get_all_user_holdings(
    query_params={"userId": user_id, "userSecret": user_secret}
)
pprint(holdings.body)

# 6) Deleting a user
deleted_response = snaptrade.authentication.delete_snap_trade_user(
    query_params={"userId": user_id}
)
pprint(deleted_response.body)

Async

async support is available by prepending a to any method.

import asyncio
from pprint import pprint
from snaptrade_client import SnapTrade, ApiException

snaptrade = SnapTrade(
    consumer_key="YOUR_CONSUMER_KEY",
    client_id="YOUR_CLIENT_ID",
)


async def main():
    try:
        # List all accounts for the user, plus balances, positions, and orders for each account.
        get_all_user_holdings_response = (
            await snaptrade.account_information.aget_all_user_holdings(
                user_id="snaptrade-user-123",
                user_secret="USERSECRET123",
                brokerage_authorizations="917c8734-8470-4a3e-a18f-57c3f2ee6631",
            )
        )
        pprint(get_all_user_holdings_response.body)
        pprint(get_all_user_holdings_response.body["account"])
        pprint(get_all_user_holdings_response.body["balances"])
        pprint(get_all_user_holdings_response.body["positions"])
        pprint(get_all_user_holdings_response.body["total_value"])
        pprint(get_all_user_holdings_response.headers)
        pprint(get_all_user_holdings_response.status)
        pprint(get_all_user_holdings_response.round_trip_time)
    except ApiException as e:
        print(
            "Exception when calling AccountInformationApi.get_all_user_holdings: %s\n"
            % e
        )
        pprint(e.body)
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())

Reference

`snaptrade.account_information.get_all_user_holdings`

Deprecated

Deprecated, please use the account-specific holdings endpoint instead.

List all accounts for the user, plus balances, positions, and orders for each account.

🛠️ Usage

get_all_user_holdings_response = snaptrade.account_information.get_all_user_holdings(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    brokerage_authorizations="917c8734-8470-4a3e-a18f-57c3f2ee6631",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

brokerage_authorizations: `str`

Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).

🔄 Return

AccountHoldings

🌐 Endpoint

/holdings get

🔙 Back to Table of Contents

`snaptrade.account_information.get_user_account_balance`

A list of account balances for the specified account (one per currency that the account holds).

🛠️ Usage

get_user_account_balance_response = (
    snaptrade.account_information.get_user_account_balance(
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to get balances.

🔄 Return

Balance

🌐 Endpoint

/accounts/{accountId}/balances get

🔙 Back to Table of Contents

`snaptrade.account_information.get_user_account_details`

Returns an account object with details for the specified account, including the total account market value.

🛠️ Usage

get_user_account_details_response = (
    snaptrade.account_information.get_user_account_details(
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to get detail of.

🔄 Return

Account

🌐 Endpoint

/accounts/{accountId} get

🔙 Back to Table of Contents

`snaptrade.account_information.get_user_account_orders`

Fetch all recent orders from a user's account.

🛠️ Usage

get_user_account_orders_response = (
    snaptrade.account_information.get_user_account_orders(
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
        state="all",
        days=30,
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to get orders.

state: `str`

defaults value is set to "all"

days: `int`

Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.

🔄 Return

AccountOrderRecord

🌐 Endpoint

/accounts/{accountId}/orders get

🔙 Back to Table of Contents

`snaptrade.account_information.get_user_account_positions`

Returns a list of positions in the specified account.

🛠️ Usage

get_user_account_positions_response = (
    snaptrade.account_information.get_user_account_positions(
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to get positions.

🔄 Return

Position

🌐 Endpoint

/accounts/{accountId}/positions get

🔙 Back to Table of Contents

`snaptrade.account_information.get_user_holdings`

Lists balances, positions and orders for the specified account as well as option_positions and account metadata. The data returned is similar to the data returned over the more fine-grained positions, orders and balances endpoints.

🛠️ Usage

get_user_holdings_response = snaptrade.account_information.get_user_holdings(
    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
)

⚙️ Parameters

account_id: `str`

The ID of the account to fetch holdings for.

user_id: `str`

user_secret: `str`

🔄 Return

AccountHoldingsAccount

🌐 Endpoint

/accounts/{accountId}/holdings get

🔙 Back to Table of Contents

`snaptrade.account_information.list_user_accounts`

Get a list of all Account objects for the authenticated SnapTrade user.

🛠️ Usage

list_user_accounts_response = snaptrade.account_information.list_user_accounts(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

🔄 Return

Account

🌐 Endpoint

/accounts get

🔙 Back to Table of Contents

`snaptrade.account_information.update_user_account`

Updates various properties of a specified account.

🛠️ Usage

update_user_account_response = snaptrade.account_information.update_user_account(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="accountId_example",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to update.

🔄 Return

Account

🌐 Endpoint

/accounts/{accountId} put

🔙 Back to Table of Contents

`snaptrade.api_status.check`

Check whether the API is operational and verify timestamps.

🛠️ Usage

check_response = snaptrade.api_status.check()

🔄 Return

Status

🌐 Endpoint

/ get

🔙 Back to Table of Contents

`snaptrade.authentication.delete_snap_trade_user`

Deletes a user you've registered over the SnapTrade API, and any data associated with them or their investment accounts.

🛠️ Usage

delete_snap_trade_user_response = snaptrade.authentication.delete_snap_trade_user(
    user_id="snaptrade-user-123",
)

⚙️ Parameters

user_id: `str`

🔄 Return

DeleteUserResponse

🌐 Endpoint

/snapTrade/deleteUser delete

🔙 Back to Table of Contents

`snaptrade.authentication.list_snap_trade_users`

Returns a list of users you've registered over the SnapTrade API.

🛠️ Usage

list_snap_trade_users_response = snaptrade.authentication.list_snap_trade_users()

🔄 Return

UserList

🌐 Endpoint

/snapTrade/listUsers get

🔙 Back to Table of Contents

`snaptrade.authentication.login_snap_trade_user`

Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.

🛠️ Usage

login_snap_trade_user_response = snaptrade.authentication.login_snap_trade_user(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    broker="ALPACA",
    immediate_redirect=True,
    custom_redirect="https://snaptrade.com",
    reconnect="8b5f262d-4bb9-365d-888a-202bd3b15fa1",
    connection_type="read",
    connection_portal_version="v2",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

broker: `str`

Slug of the brokerage to connect the user to. See this document for a list of supported brokerages and their slugs.

immediate_redirect: `bool`

When set to True, user will be redirected back to the partner's site instead of the connection portal

custom_redirect: `str`

URL to redirect the user to after the user connects their brokerage account

reconnect: `str`

The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.

connection_type: `str`

Sets whether the connection should be read or trade

connection_portal_version: `str`

Sets the version of the connection portal to render, with a default to 'v3'

⚙️ Request Body

SnapTradeLoginUserRequestBody

🌐 Endpoint

/snapTrade/login post

🔙 Back to Table of Contents

`snaptrade.authentication.register_snap_trade_user`

Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.

🛠️ Usage

register_snap_trade_user_response = snaptrade.authentication.register_snap_trade_user(
    user_id="snaptrade-user-123",
)

⚙️ Parameters

user_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.

⚙️ Request Body

SnapTradeRegisterUserRequestBody

🔄 Return

UserIDandSecret

🌐 Endpoint

/snapTrade/registerUser post

🔙 Back to Table of Contents

`snaptrade.authentication.reset_snap_trade_user_secret`

This API is used to rotate the secret for a SnapTrade user. You might use this if a userSecret is compromised. Please note that if you call this endpoint and fail to save the new secret, you'll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.

🛠️ Usage

reset_snap_trade_user_secret_response = (
    snaptrade.authentication.reset_snap_trade_user_secret(
        user_id="snaptrade-user-123",
        user_secret="h81@cx1lkalablakwjaltkejraj11=",
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.

⚙️ Request Body

UserIDandSecret

🔄 Return

UserIDandSecret

🌐 Endpoint

/snapTrade/resetUserSecret post

🔙 Back to Table of Contents

`snaptrade.connections.detail_brokerage_authorization`

Returns a single brokerage authorization object for the specified ID.

🛠️ Usage

detail_brokerage_authorization_response = (
    snaptrade.connections.detail_brokerage_authorization(
        authorization_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
    )
)

⚙️ Parameters

authorization_id: `str`

The ID of a brokerage authorization object.

user_id: `str`

user_secret: `str`

🔄 Return

BrokerageAuthorization

🌐 Endpoint

/authorizations/{authorizationId} get

🔙 Back to Table of Contents

`snaptrade.connections.disable_brokerage_authorization`

Manually disable a connection. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a CONNECTION_BROKEN webhook for the connection. Please contact us in order to use this endpoint as it is disabled by default.

🛠️ Usage

disable_brokerage_authorization_response = (
    snaptrade.connections.disable_brokerage_authorization(
        authorization_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
    )
)

⚙️ Parameters

authorization_id: `str`

The ID of a brokerage authorization object.

user_id: `str`

user_secret: `str`

🔄 Return

BrokerageAuthorizationDisabledConfirmation

🌐 Endpoint

/authorizations/{authorizationId}/disable post

🔙 Back to Table of Contents

`snaptrade.connections.list_brokerage_authorizations`

Returns a list of Brokerage Authorization objects for the user

🛠️ Usage

list_brokerage_authorizations_response = (
    snaptrade.connections.list_brokerage_authorizations(
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

🔄 Return

BrokerageAuthorization

🌐 Endpoint

/authorizations get

🔙 Back to Table of Contents

`snaptrade.connections.refresh_brokerage_authorization`

Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default

🛠️ Usage

refresh_brokerage_authorization_response = (
    snaptrade.connections.refresh_brokerage_authorization(
        authorization_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
    )
)

⚙️ Parameters

authorization_id: `str`

The ID of a brokerage authorization object.

user_id: `str`

user_secret: `str`

🔄 Return

BrokerageAuthorizationRefreshConfirmation

🌐 Endpoint

/authorizations/{authorizationId}/refresh post

🔙 Back to Table of Contents

`snaptrade.connections.remove_brokerage_authorization`

Deletes a specified brokerage authorization given by the ID.

🛠️ Usage

snaptrade.connections.remove_brokerage_authorization(
    authorization_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
)

⚙️ Parameters

authorization_id: `str`

The ID of the Authorization to delete.

user_id: `str`

user_secret: `str`

🌐 Endpoint

/authorizations/{authorizationId} delete

🔙 Back to Table of Contents

`snaptrade.connections.session_events`

Returns a list of session events associated with a user.

🛠️ Usage

session_events_response = snaptrade.connections.session_events(
    partner_client_id="SNAPTRADETEST",
    user_id="917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
    session_id="917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
)

⚙️ Parameters

partner_client_id: `str`

user_id: `str`

Optional comma seperated list of user IDs used to filter the request on specific users

session_id: `str`

Optional comma seperated list of session IDs used to filter the request on specific users

🌐 Endpoint

/sessionEvents get

🔙 Back to Table of Contents

`snaptrade.options.get_option_strategy`

Creates an option strategy object that will be used to place an option strategy order.

🛠️ Usage

get_option_strategy_response = snaptrade.options.get_option_strategy(
    underlying_symbol_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    legs=[
        {
            "action": "BUY_TO_OPEN",
            "option_symbol_id": "SPY220819P00200000",
            "quantity": 1,
        }
    ],
    strategy_type="CUSTOM",
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="accountId_example",
)

⚙️ Parameters

underlying_symbol_id: `str`

legs: List[`OptionLeg`]

strategy_type: `str`

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to create the option strategy object in.

⚙️ Request Body

Any

🔄 Return

StrategyQuotes

🌐 Endpoint

/accounts/{accountId}/optionStrategy post

🔙 Back to Table of Contents

`snaptrade.options.get_options_chain`

Returns the option chain for the specified symbol in the specified account.

🛠️ Usage

get_options_chain_response = snaptrade.options.get_options_chain(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="accountId_example",
    symbol="symbol_example",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to get the options chain from.

symbol: `str`

Universal symbol ID if symbol

🔄 Return

OptionChain

🌐 Endpoint

/accounts/{accountId}/optionsChain get

🔙 Back to Table of Contents

`snaptrade.options.get_options_strategy_quote`

Returns a Strategy Quotes object which has latest market data of the specified option strategy.

🛠️ Usage

get_options_strategy_quote_response = snaptrade.options.get_options_strategy_quote(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="accountId_example",
    option_strategy_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account the strategy will be placed in.

option_strategy_id: `str`

Option strategy id obtained from response when creating option strategy object

🔄 Return

StrategyQuotes

🌐 Endpoint

/accounts/{accountId}/optionStrategy/{optionStrategyId} get

🔙 Back to Table of Contents

`snaptrade.options.list_option_holdings`

Returns a list of Options Positions.

🛠️ Usage

list_option_holdings_response = snaptrade.options.list_option_holdings(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="accountId_example",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to fetch options holdings for.

🔄 Return

OptionsPosition

🌐 Endpoint

/accounts/{accountId}/options get

🔙 Back to Table of Contents

`snaptrade.options.place_option_strategy`

Places the option strategy order and returns the order record received from the brokerage.

🛠️ Usage

place_option_strategy_response = snaptrade.options.place_option_strategy(
    order_type="Limit",
    time_in_force="FOK",
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    option_strategy_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    price=31.33,
)

⚙️ Parameters

order_type: `OrderTypeStrict`

time_in_force: `TimeInForceStrict`

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to execute the strategy in.

option_strategy_id: `str`

Option strategy id obtained from response when creating option strategy object

price: `Price`

⚙️ Request Body

Any

🔄 Return

StrategyOrderRecord

🌐 Endpoint

/accounts/{accountId}/optionStrategy/{optionStrategyId}/execute post

🔙 Back to Table of Contents

`snaptrade.reference_data.get_currency_exchange_rate_pair`

Returns an Exchange Rate Pair object for the specified Currency Pair.

🛠️ Usage

get_currency_exchange_rate_pair_response = (
    snaptrade.reference_data.get_currency_exchange_rate_pair(
        currency_pair="currencyPair_example",
    )
)

⚙️ Parameters

currency_pair: `str`

A currency pair based on currency code for example, {CAD-USD}

🔄 Return

ExchangeRatePairs

🌐 Endpoint

/currencies/rates/{currencyPair} get

🔙 Back to Table of Contents

`snaptrade.reference_data.get_partner_info`

Returns useful data related to the specified ClientID, including allowed brokerages and data access.

🛠️ Usage

get_partner_info_response = snaptrade.reference_data.get_partner_info()

🔄 Return

PartnerData

🌐 Endpoint

/snapTrade/partners get

🔙 Back to Table of Contents

`snaptrade.reference_data.get_security_types`

List security types available on SnapTrade.

🛠️ Usage

get_security_types_response = snaptrade.reference_data.get_security_types()

🔄 Return

SecurityType

🌐 Endpoint

/securityTypes get

🔙 Back to Table of Contents

`snaptrade.reference_data.get_stock_exchanges`

Returns a list of all supported Exchanges.

🛠️ Usage

get_stock_exchanges_response = snaptrade.reference_data.get_stock_exchanges()

🔄 Return

Exchange

🌐 Endpoint

/exchanges get

🔙 Back to Table of Contents

`snaptrade.reference_data.get_symbols`

Returns a list of Universal Symbol objects that match a defined string.

Matches on ticker or name.

🛠️ Usage

get_symbols_response = snaptrade.reference_data.get_symbols(
    substring="apple",
)

⚙️ Parameters

substring: `str`

⚙️ Request Body

SymbolQuery

🔄 Return

UniversalSymbol

🌐 Endpoint

/symbols post

🔙 Back to Table of Contents

`snaptrade.reference_data.get_symbols_by_ticker`

Returns the Universal Symbol object specified by the ticker or the universal_symbol_id.

🛠️ Usage

get_symbols_by_ticker_response = snaptrade.reference_data.get_symbols_by_ticker(
    query="query_example",
)

⚙️ Parameters

query: `str`

The ticker or universal_symbol_id of the UniversalSymbol to get.

🔄 Return

UniversalSymbol

🌐 Endpoint

/symbols/{query} get

🔙 Back to Table of Contents

`snaptrade.reference_data.list_all_brokerage_authorization_type`

Returns a list of all defined Brokerage authorization Type objects.

🛠️ Usage

list_all_brokerage_authorization_type_response = (
    snaptrade.reference_data.list_all_brokerage_authorization_type(
        brokerage="QUESTRADE,ALPACA",
    )
)

⚙️ Parameters

brokerage: `str`

Comma separated value of brokerage slugs

🔄 Return

BrokerageAuthorizationTypeReadOnly

🌐 Endpoint

/brokerageAuthorizationTypes get

🔙 Back to Table of Contents

`snaptrade.reference_data.list_all_brokerages`

Returns a list of all defined Brokerage objects.

🛠️ Usage

list_all_brokerages_response = snaptrade.reference_data.list_all_brokerages()

🔄 Return

Brokerage

🌐 Endpoint

/brokerages get

🔙 Back to Table of Contents

`snaptrade.reference_data.list_all_currencies`

Returns a list of all defined Currency objects.

🛠️ Usage

list_all_currencies_response = snaptrade.reference_data.list_all_currencies()

🔄 Return

Currency

🌐 Endpoint

/currencies get

🔙 Back to Table of Contents

`snaptrade.reference_data.list_all_currencies_rates`

Returns a list of all Exchange Rate Pairs for all supported Currencies.

🛠️ Usage

list_all_currencies_rates_response = (
    snaptrade.reference_data.list_all_currencies_rates()
)

🔄 Return

ExchangeRatePairs

🌐 Endpoint

/currencies/rates get

🔙 Back to Table of Contents

`snaptrade.reference_data.symbol_search_user_account`

Returns a list of universal symbols that are supported by the specificied account. Returned symbols are based on the provided search string, matching on ticker and name.

🛠️ Usage

symbol_search_user_account_response = (
    snaptrade.reference_data.symbol_search_user_account(
        user_id="snaptrade-user-123",
        user_secret="USERSECRET123",
        account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
        substring="apple",
    )
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to search for symbols within.

substring: `str`

⚙️ Request Body

SymbolQuery

🔄 Return

UniversalSymbol

🌐 Endpoint

/accounts/{accountId}/symbols post

🔙 Back to Table of Contents

`snaptrade.trading.cancel_user_account_order`

Sends a signal to the brokerage to cancel the specified order. This will only work if the order has not yet been executed.

🛠️ Usage

cancel_user_account_order_response = snaptrade.trading.cancel_user_account_order(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    brokerage_order_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

The ID of the account to cancel the order in.

brokerage_order_id: `str`

⚙️ Request Body

Any The Order ID to be canceled

🔄 Return

AccountOrderRecord

🌐 Endpoint

/accounts/{accountId}/orders/cancel post

🔙 Back to Table of Contents

`snaptrade.trading.get_order_impact`

Return the trade object and it's impact on the account for the specified order.

🛠️ Usage

get_order_impact_response = snaptrade.trading.get_order_impact(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    action="BUY",
    order_type="Limit",
    price=31.33,
    stop=31.33,
    time_in_force="FOK",
    units=3.14,
    universal_symbol_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    notional_value=None,
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

action: `ActionStrict`

order_type: `OrderTypeStrict`

price: `Price`

stop: `StopPrice`

time_in_force: `TimeInForceStrict`

units: `UnitsNullable`

universal_symbol_id: `str`

notional_value: `NotionalValueNullable`

⚙️ Request Body

ManualTradeForm

🔄 Return

ManualTradeAndImpact

🌐 Endpoint

/trade/impact post

🔙 Back to Table of Contents

`snaptrade.trading.get_user_account_quotes`

Returns quote(s) from the brokerage for the specified symbol(s).

🛠️ Usage

get_user_account_quotes_response = snaptrade.trading.get_user_account_quotes(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    symbols="symbols_example",
    account_id="917c8734-8470-4a3e-a18f-57c3f2ee6631",
    use_ticker=True,
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

symbols: `str`

List of universal_symbol_id or tickers to get quotes for.

account_id: `str`

The ID of the account to get quotes.

use_ticker: `bool`

Should be set to True if providing tickers.

🔄 Return

SymbolsQuotes

🌐 Endpoint

/accounts/{accountId}/quotes get

🔙 Back to Table of Contents

`snaptrade.trading.place_force_order`

Places a specified trade in the specified account.

🛠️ Usage

place_force_order_response = snaptrade.trading.place_force_order(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    account_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    action="BUY",
    order_type="Limit",
    price=31.33,
    stop=31.33,
    time_in_force="FOK",
    units=3.14,
    universal_symbol_id="2bcd7cc3-e922-4976-bce1-9858296801c3",
    notional_value=None,
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

account_id: `str`

action: `ActionStrict`

order_type: `OrderTypeStrict`

price: `Price`

stop: `StopPrice`

time_in_force: `TimeInForceStrict`

units: `UnitsNullable`

universal_symbol_id: `str`

notional_value: `NotionalValueNullable`

⚙️ Request Body

ManualTradeForm

🔄 Return

AccountOrderRecord

🌐 Endpoint

/trade/place post

🔙 Back to Table of Contents

`snaptrade.trading.place_order`

Places the specified trade object. This places the order in the account and returns the status of the order from the brokerage.

🛠️ Usage

place_order_response = snaptrade.trading.place_order(
    trade_id="tradeId_example",
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    wait_to_confirm=True,
)

⚙️ Parameters

trade_id: `str`

The ID of trade object obtained from trade/impact endpoint

user_id: `str`

user_secret: `str`

wait_to_confirm: `Optional[bool]`

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

⚙️ Request Body

ValidatedTradeBody

🔄 Return

AccountOrderRecord

🌐 Endpoint

/trade/{tradeId} post

🔙 Back to Table of Contents

`snaptrade.transactions_and_reporting.get_activities`

Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance

🛠️ Usage

get_activities_response = snaptrade.transactions_and_reporting.get_activities(
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    start_date="2022-01-24",
    end_date="2022-01-24",
    accounts="917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
    brokerage_authorizations="917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
    type="DIVIDEND",
)

⚙️ Parameters

user_id: `str`

user_secret: `str`

start_date: `date`

end_date: `date`

accounts: `str`

Optional comma seperated list of account IDs used to filter the request on specific accounts

brokerage_authorizations: `str`

Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations

type: `str`

Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT

🔄 Return

UniversalActivity

🌐 Endpoint

/activities get

🔙 Back to Table of Contents

`snaptrade.transactions_and_reporting.get_reporting_custom_range`

Deprecated

Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.

🛠️ Usage

get_reporting_custom_range_response = snaptrade.transactions_and_reporting.get_reporting_custom_range(
    start_date="2022-01-24",
    end_date="2022-01-24",
    user_id="snaptrade-user-123",
    user_secret="USERSECRET123",
    accounts="917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
    detailed=True,
    frequency="monthly",
)

⚙️ Parameters

start_date: `date`

end_date: `date`

user_id: `str`

user_secret: `str`

accounts: `str`

Optional comma seperated list of account IDs used to filter the request on specific accounts

detailed: `bool`

Optional, increases frequency of data points for the total value and contribution charts if set to true

frequency: `str`

Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.

🔄 Return

PerformanceCustom

🌐 Endpoint

/performance/custom get

🔙 Back to Table of Contents

Author

This Python package is automatically generated by Konfig

Project details

These details have not been verified by PyPI

Release history Release notifications | RSS feed

11.0.50

Oct 30, 2024

11.0.49

Oct 29, 2024

11.0.48

Oct 28, 2024

11.0.47

Oct 7, 2024

11.0.46

Oct 2, 2024

11.0.45

Sep 25, 2024

11.0.44

Sep 21, 2024

11.0.43

Sep 9, 2024

11.0.42

Sep 5, 2024

11.0.41

Sep 5, 2024

11.0.40

Sep 3, 2024

11.0.39

Aug 23, 2024

11.0.38

Aug 22, 2024

11.0.37

Aug 21, 2024

11.0.36

Aug 21, 2024

11.0.35

Aug 20, 2024

11.0.34

Aug 19, 2024

11.0.33

Aug 16, 2024

11.0.32

Aug 15, 2024

11.0.31

Aug 14, 2024

11.0.30

Aug 2, 2024

This version

11.0.29

Aug 1, 2024

11.0.28

Jul 16, 2024

11.0.27

Jul 12, 2024

11.0.26

Jun 28, 2024

11.0.25

Jun 27, 2024

11.0.24

Jun 26, 2024

11.0.23

Jun 20, 2024

11.0.22

Jun 14, 2024

11.0.21

Jun 11, 2024

11.0.20

Jun 5, 2024

11.0.19

May 24, 2024

11.0.18

May 21, 2024

11.0.17

May 10, 2024

11.0.16

May 8, 2024

11.0.15

May 3, 2024

11.0.14

May 3, 2024

11.0.13

Apr 18, 2024

11.0.12

Apr 12, 2024

11.0.11

Apr 5, 2024

11.0.10

Mar 14, 2024

11.0.9

Mar 12, 2024

11.0.8

Mar 5, 2024

11.0.7

Feb 23, 2024

11.0.6

Feb 16, 2024

11.0.5

Feb 14, 2024

11.0.4

Feb 9, 2024

11.0.3

Feb 2, 2024

11.0.2

Feb 1, 2024

11.0.1

Jan 29, 2024

11.0.0

Jan 24, 2024

10.34.14

Jan 17, 2024

10.34.13

Jan 16, 2024

10.34.12

Jan 11, 2024

10.34.11

Jan 3, 2024

10.34.10

Dec 12, 2023

10.34.9

Dec 4, 2023

10.34.8

Nov 30, 2023

10.34.7

Nov 15, 2023

10.34.6

Nov 8, 2023

10.34.5

Nov 6, 2023

10.34.4

Nov 1, 2023

10.34.3

Oct 18, 2023

10.34.2

Oct 13, 2023

10.34.1

Oct 10, 2023

10.34.0

Oct 7, 2023

10.33.3

Sep 26, 2023

10.33.2

Sep 19, 2023

10.33.1

Sep 7, 2023

10.33.0

Sep 2, 2023

10.32.3

Aug 31, 2023

10.32.2

Aug 19, 2023

10.32.1

Aug 18, 2023

10.32.0

Aug 16, 2023

10.31.1

Aug 15, 2023

10.31.0

Aug 14, 2023

10.30.0

Aug 11, 2023

10.29.0

Aug 11, 2023

10.28.0

Aug 9, 2023

10.27.2

Aug 7, 2023

10.27.1

Aug 7, 2023

10.27.0

Aug 4, 2023

10.26.0

Aug 2, 2023

10.25.0

Jul 31, 2023

10.24.0

Jul 27, 2023

10.23.0

Jul 27, 2023

10.22.0

Jul 18, 2023

10.21.0

Jun 22, 2023

10.20.0

Jun 13, 2023

10.19.0

Jun 7, 2023

10.18.0

Jun 5, 2023

10.17.0

Jun 1, 2023

10.16.0

May 31, 2023

10.15.0

May 26, 2023

10.14.0

May 18, 2023

10.13.0

May 16, 2023

10.12.0

May 15, 2023

10.11.0

May 10, 2023

10.10.0

May 10, 2023

10.9.0

May 2, 2023

10.8.0

May 1, 2023

10.7.0

Apr 28, 2023

10.6.0

Apr 23, 2023

10.5.0

Apr 21, 2023

10.4.0

Apr 18, 2023

10.3.0

Apr 17, 2023

10.2.0

Apr 15, 2023

10.1.0

Apr 15, 2023

10.0.0

Apr 12, 2023

9.0.0

Apr 12, 2023

8.4.0

Apr 6, 2023

8.3.0

Mar 31, 2023

8.2.0

Mar 31, 2023

8.1.0

Mar 28, 2023

8.0.0

Mar 15, 2023

7.0.0

Mar 2, 2023

6.0.0

Mar 1, 2023

5.0.0

Feb 28, 2023

4.0.0

Feb 27, 2023

3.0.0

Feb 10, 2023

2.4.0

Feb 6, 2023

2.3.0

Jan 30, 2023

2.2.0

Jan 30, 2023

2.1.0

Jan 27, 2023

2.0.0

Jan 20, 2023

1.0.1

Nov 10, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snaptrade_python_sdk-11.0.29.tar.gz (209.6 kB view hashes)

Uploaded Aug 1, 2024 Source

Built Distribution

snaptrade_python_sdk-11.0.29-py3-none-any.whl (848.9 kB view hashes)

Uploaded Aug 1, 2024 Python 3

Hashes for snaptrade_python_sdk-11.0.29.tar.gz

Hashes for snaptrade_python_sdk-11.0.29.tar.gz
Algorithm	Hash digest
SHA256	`726f6396e5b3fee2cc2a15d0bb9a48af11df027814b0be7dbad5c83b637bded9`
MD5	`914ca8aa3cbe5a9b572db86968afee4e`
BLAKE2b-256	`ccb6e303080917b2b421455a25ed2dd042d7c5a36b5b56522546cd4567f8d5f6`

Hashes for snaptrade_python_sdk-11.0.29-py3-none-any.whl

Hashes for snaptrade_python_sdk-11.0.29-py3-none-any.whl
Algorithm	Hash digest
SHA256	`ba24f06c87fa25c338a23e7f0cb4c798a9da401780dbc0d903bf11554027e5c1`
MD5	`e0f5df4fc7c6d282bc241ad4dcaa1610`
BLAKE2b-256	`d2dbe29173a927ef951aaa0b71bf54dec16413e583f79b85518d7e58069399de`

snaptrade-python-sdk 11.0.29

Navigation

Verified details

Maintainers

Unverified details

Meta

Classifiers

Project description

SnapTrade

Table of Contents

Requirements

Installation

Getting Started

Async

Reference

snaptrade.account_information.get_all_user_holdings

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

brokerage_authorizations: str

🔄 Return

🌐 Endpoint

snaptrade.account_information.get_user_account_balance

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

account_id: str

🔄 Return

🌐 Endpoint

snaptrade.account_information.get_user_account_details

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

account_id: str

🔄 Return

🌐 Endpoint

snaptrade.account_information.get_user_account_orders

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

account_id: str

state: str

days: int

🔄 Return

🌐 Endpoint

snaptrade.account_information.get_user_account_positions

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

account_id: str

🔄 Return

🌐 Endpoint

snaptrade.account_information.get_user_holdings

🛠️ Usage

⚙️ Parameters

account_id: str

user_id: str

user_secret: str

🔄 Return

🌐 Endpoint

snaptrade.account_information.list_user_accounts

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

🔄 Return

🌐 Endpoint

snaptrade.account_information.update_user_account

🛠️ Usage

⚙️ Parameters

user_id: str

user_secret: str

account_id: str

🔄 Return

🌐 Endpoint

`snaptrade.account_information.get_all_user_holdings`

user_id: `str`

user_secret: `str`

brokerage_authorizations: `str`

`snaptrade.account_information.get_user_account_balance`

user_id: `str`

user_secret: `str`

account_id: `str`

`snaptrade.account_information.get_user_account_details`

user_id: `str`

user_secret: `str`

account_id: `str`

`snaptrade.account_information.get_user_account_orders`

user_id: `str`

user_secret: `str`

account_id: `str`

state: `str`

days: `int`

`snaptrade.account_information.get_user_account_positions`

user_id: `str`

user_secret: `str`

account_id: `str`

`snaptrade.account_information.get_user_holdings`

account_id: `str`

user_id: `str`

user_secret: `str`

`snaptrade.account_information.list_user_accounts`

user_id: `str`

user_secret: `str`

`snaptrade.account_information.update_user_account`

user_id: `str`

user_secret: `str`

account_id: `str`

`snaptrade.api_status.check`

`snaptrade.authentication.delete_snap_trade_user`

user_id: `str`

`snaptrade.authentication.list_snap_trade_users`

`snaptrade.authentication.login_snap_trade_user`

user_id: `str`

user_secret: `str`

broker: `str`

immediate_redirect: `bool`

custom_redirect: `str`

reconnect: `str`

connection_type: `str`

connection_portal_version: `str`

`snaptrade.authentication.register_snap_trade_user`

user_id: `str`

`snaptrade.authentication.reset_snap_trade_user_secret`

user_id: `str`

user_secret: `str`

`snaptrade.connections.detail_brokerage_authorization`

authorization_id: `str`

user_id: `str`

user_secret: `str`

`snaptrade.connections.disable_brokerage_authorization`

authorization_id: `str`

user_id: `str`

user_secret: `str`

`snaptrade.connections.list_brokerage_authorizations`

user_id: `str`

user_secret: `str`

`snaptrade.connections.refresh_brokerage_authorization`

authorization_id: `str`

user_id: `str`