Client for SnapTrade
Project description
Table of Contents
- Requirements
- Installation
- Getting Started
- Async
- Reference
snaptrade.account_information.get_all_user_holdings
snaptrade.account_information.get_user_account_balance
snaptrade.account_information.get_user_account_details
snaptrade.account_information.get_user_account_orders
snaptrade.account_information.get_user_account_positions
snaptrade.account_information.get_user_holdings
snaptrade.account_information.list_user_accounts
snaptrade.account_information.update_user_account
snaptrade.api_status.check
snaptrade.authentication.delete_snap_trade_user
snaptrade.authentication.list_snap_trade_users
snaptrade.authentication.login_snap_trade_user
snaptrade.authentication.register_snap_trade_user
snaptrade.authentication.reset_snap_trade_user_secret
snaptrade.connections.detail_brokerage_authorization
snaptrade.connections.disable_brokerage_authorization
snaptrade.connections.list_brokerage_authorizations
snaptrade.connections.refresh_brokerage_authorization
snaptrade.connections.remove_brokerage_authorization
snaptrade.connections.session_events
snaptrade.options.get_option_strategy
snaptrade.options.get_options_chain
snaptrade.options.get_options_strategy_quote
snaptrade.options.list_option_holdings
snaptrade.options.place_option_strategy
snaptrade.reference_data.get_currency_exchange_rate_pair
snaptrade.reference_data.get_partner_info
snaptrade.reference_data.get_security_types
snaptrade.reference_data.get_stock_exchanges
snaptrade.reference_data.get_symbols
snaptrade.reference_data.get_symbols_by_ticker
snaptrade.reference_data.list_all_brokerage_authorization_type
snaptrade.reference_data.list_all_brokerages
snaptrade.reference_data.list_all_currencies
snaptrade.reference_data.list_all_currencies_rates
snaptrade.reference_data.symbol_search_user_account
snaptrade.trading.cancel_user_account_order
snaptrade.trading.get_order_impact
snaptrade.trading.get_user_account_quotes
snaptrade.trading.place_force_order
snaptrade.trading.place_order
snaptrade.transactions_and_reporting.get_activities
snaptrade.transactions_and_reporting.get_reporting_custom_range
Requirements
Python >=3.7
Installation
pip install snaptrade-python-sdk==11.0.35
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, 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 separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
๐ Return
๐ Endpoint
/holdings
get
๐ Back to Table of Contents
snaptrade.account_information.get_user_account_balance
Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade allows holding multiple currencies in the same account.
The data returned here is cached. How long the data is cached for varies by brokerage. Check the brokerage integrations doc and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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
๐ Return
๐ Endpoint
/accounts/{accountId}/balances
get
๐ Back to Table of Contents
snaptrade.account_information.get_user_account_details
Returns account detail known to SnapTrade for the specified account.
The data returned here is always cached and refreshed once a day. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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
๐ Return
๐ Endpoint
/accounts/{accountId}
get
๐ Back to Table of Contents
snaptrade.account_information.get_user_account_orders
Returns a list of recent orders in the specified account.
The data returned here is cached. How long the data is cached for varies by brokerage. Check the brokerage integrations doc and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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
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
๐ Endpoint
/accounts/{accountId}/orders
get
๐ Back to Table of Contents
snaptrade.account_information.get_user_account_positions
Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the options endpoint.
The data returned here is cached. How long the data is cached for varies by brokerage. Check the brokerage integrations doc and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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
๐ Return
๐ Endpoint
/accounts/{accountId}/positions
get
๐ Back to Table of Contents
snaptrade.account_information.get_user_holdings
Returns a list of balances, positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained balances, positions and orders endpoints. The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.
The data returned here is cached. How long the data is cached for varies by brokerage. Check the brokerage integrations doc and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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
user_id: str
user_secret: str
๐ Return
๐ Endpoint
/accounts/{accountId}/holdings
get
๐ Back to Table of Contents
snaptrade.account_information.list_user_accounts
Returns all brokerage accounts known to SnapTrade for the authenticated user.
The data returned here is always cached and refreshed once a day. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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
๐ 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
๐ 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
๐ Endpoint
/
get
๐ Back to Table of Contents
snaptrade.authentication.delete_snap_trade_user
Deletes a registered user and all associated data. This action is irreversible. This API is asynchronous and will return a 200 status code if the request is accepted. The user and all associated data will be queued for deletion. Once deleted, a USER_DELETED
webhook will be sent.
๐ ๏ธ Usage
delete_snap_trade_user_response = snaptrade.authentication.delete_snap_trade_user(
user_id="snaptrade-user-123",
)
โ๏ธ Parameters
user_id: str
๐ Return
๐ Endpoint
/snapTrade/deleteUser
delete
๐ Back to Table of Contents
snaptrade.authentication.list_snap_trade_users
Returns a list of all registered user IDs.
๐ ๏ธ Usage
list_snap_trade_users_response = snaptrade.authentication.list_snap_trade_users()
๐ Return
๐ 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="v3",
)
โ๏ธ Parameters
user_id: str
user_secret: str
broker: str
Slug of the brokerage to connect the user to. See the integrations page 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. This parameter is ignored if the connection portal is loaded inside an iframe. See the guide on ways to integrate the connection portal for more information.
custom_redirect: str
URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the guide on ways to integrate the connection portal for more information.
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 the guide on fixing broken connections for more information.
connection_type: str
Sets whether the connection should be read-only or trade-enabled.
connection_portal_version: str
Sets the version of the connection portal to render.
โ๏ธ Request Body
๐ 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
๐ Endpoint
/snapTrade/registerUser
post
๐ Back to Table of Contents
snaptrade.authentication.reset_snap_trade_user_secret
Rotates the secret for a SnapTrade user. You might use this if 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
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_secret: str
SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the rotate user secret endpoint
โ๏ธ Request Body
๐ Return
๐ 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
๐ 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
๐ 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 separated list of user IDs used to filter the request on specific users
session_id: str
Optional comma separated 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
๐ Return
๐ 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
๐ 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
๐ Endpoint
/accounts/{accountId}/optionStrategy/{optionStrategyId}
get
๐ Back to Table of Contents
snaptrade.options.list_option_holdings
Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the positions endpoint.
The data returned here is cached. How long the data is cached for varies by brokerage. Check the brokerage integrations doc and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ Usage
list_option_holdings_response = snaptrade.options.list_option_holdings(
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
๐ Return
๐ 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
๐ Return
๐ 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
๐ 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
๐ 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
๐ 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
๐ 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
๐ Return
๐ 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
๐ 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
๐ 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
๐ 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
๐ 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
๐ Return
๐ 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
๐ 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
๐ Return
๐ 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
๐ 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
๐ Return
๐ 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
๐ Return
๐ Endpoint
/trade/{tradeId}
post
๐ Back to Table of Contents
snaptrade.transactions_and_reporting.get_activities
Returns all historical transactions for the specified user and filtering criteria. It's recommended to use startDate
and endDate
to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the trade_date
field if you need them in a specific order.
The data returned here is always cached and refreshed once a day. If you need real-time data, please use the manual refresh endpoint.
๐ ๏ธ 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="BUY,SELL,DIVIDEND",
)
โ๏ธ Parameters
user_id: str
user_secret: str
start_date: date
The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on trade_date
.
end_date: date
The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on trade_date
.
accounts: str
Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The brokerageAuthorizations
parameter takes precedence over this parameter.
brokerage_authorizations: str
Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the accounts
parameter.
type: str
Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
๐ Return
๐ Endpoint
/activities
get
๐ Back to Table of Contents
snaptrade.transactions_and_reporting.get_reporting_custom_range
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 separated 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
๐ Endpoint
/performance/custom
get
๐ Back to Table of Contents
Author
This Python package is automatically generated by Konfig
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for snaptrade_python_sdk-11.0.35.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3435d6b4ece3d9004ab5ca684e728a108bd3bfec8d4a8fd731e808f6909f36c |
|
MD5 | 2f2f2122b91ee8201f30151e3bad1e85 |
|
BLAKE2b-256 | 2b06412b3c2178400dc2ff997bff3592764199531de8ac80bca5f563b9ca2504 |
Hashes for snaptrade_python_sdk-11.0.35-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76194014bc77a4b53d16582f9e8b737ca28134402080dd501f6d745a391083cf |
|
MD5 | 18927766c02f14677b7603f12e40ceee |
|
BLAKE2b-256 | d04c33b7100650edcef9ec61df20afecdf8239fe65c36dee129f08e817fee865 |