snaptrade.account_information.get_account_activitiessnaptrade.account_information.get_all_user_holdingssnaptrade.account_information.get_user_account_balancesnaptrade.account_information.get_user_account_detailssnaptrade.account_information.get_user_account_order_detailsnaptrade.account_information.get_user_account_orderssnaptrade.account_information.get_user_account_positionssnaptrade.account_information.get_user_account_recent_orderssnaptrade.account_information.get_user_account_return_ratessnaptrade.account_information.get_user_holdingssnaptrade.account_information.list_user_accountssnaptrade.account_information.update_user_accountsnaptrade.api_status.checksnaptrade.authentication.delete_snap_trade_usersnaptrade.authentication.list_snap_trade_userssnaptrade.authentication.login_snap_trade_usersnaptrade.authentication.register_snap_trade_usersnaptrade.authentication.reset_snap_trade_user_secretsnaptrade.connections.detail_brokerage_authorizationsnaptrade.connections.disable_brokerage_authorizationsnaptrade.connections.list_brokerage_authorizationssnaptrade.connections.refresh_brokerage_authorizationsnaptrade.connections.remove_brokerage_authorizationsnaptrade.connections.return_ratessnaptrade.connections.session_eventssnaptrade.options.get_options_chainsnaptrade.options.list_option_holdingssnaptrade.reference_data.get_currency_exchange_rate_pairsnaptrade.reference_data.get_partner_infosnaptrade.reference_data.get_security_typessnaptrade.reference_data.get_stock_exchangessnaptrade.reference_data.get_symbolssnaptrade.reference_data.get_symbols_by_tickersnaptrade.reference_data.list_all_brokerage_authorization_typesnaptrade.reference_data.list_all_brokerage_instrumentssnaptrade.reference_data.list_all_brokeragessnaptrade.reference_data.list_all_currenciessnaptrade.reference_data.list_all_currencies_ratessnaptrade.reference_data.symbol_search_user_accountsnaptrade.trading.cancel_ordersnaptrade.trading.cancel_user_account_ordersnaptrade.trading.get_cryptocurrency_pair_quotesnaptrade.trading.get_order_impactsnaptrade.trading.get_user_account_quotessnaptrade.trading.place_bracket_ordersnaptrade.trading.place_crypto_ordersnaptrade.trading.place_force_ordersnaptrade.trading.place_mleg_ordersnaptrade.trading.place_ordersnaptrade.trading.preview_crypto_ordersnaptrade.trading.replace_ordersnaptrade.trading.search_cryptocurrency_pair_instrumentssnaptrade.transactions_and_reporting.get_activitiessnaptrade.transactions_and_reporting.get_reporting_custom_rangeAdd to Gemfile:
gem 'snaptrade', '~> 2.0.127'
require 'snaptrade'
configuration = SnapTrade::Configuration.new
configuration.client_id = ENV["SNAPTRADE_CLIENT_ID"]
configuration.consumer_key = ENV["SNAPTRADE_CONSUMER_KEY"]
snaptrade = SnapTrade::Client.new(configuration)
result = snaptrade.account_information.get_account_activities(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
start_date: "2022-01-24",
end_date: "2022-01-24",
offset: 0,
limit: 1,
type: "BUY,SELL,DIVIDEND",
)
p result
To access the raw HTTP response, suffix any method with _with_http_info.
result = snaptrade.account_information.get_account_activities_with_http_info(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
start_date: "2022-01-24",
end_date: "2022-01-24",
offset: 0,
limit: 1,
type: "BUY,SELL,DIVIDEND",
)
p result[0] # [PaginatedUniversalActivity] Deserialized data
p.result[1] # [Integer] HTTP status code
p.result[2] # [Hash] HTTP headers
p.result[3] # [Faraday::Response] Raw HTTP response
snaptrade.account_information.get_account_activitiesReturns all historical transactions for the specified account.
This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
Transaction are returned in reverse chronological order, using the trade_date field.
The data returned here is always cached and refreshed once a day.
result = snaptrade.account_information.get_account_activities(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
start_date: "2022-01-24",
end_date: "2022-01-24",
offset: 0,
limit: 1,
type: "BUY,SELL,DIVIDEND",
)
p result
StringStringStringDateThe 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.
DateThe 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.
IntegerAn integer that specifies the starting point of the paginated results. Default is 0.
IntegerAn integer that specifies the maximum number of transactions to return. Default of 1000.
StringOptional 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 - Asset bought. -
SELL - Asset sold. - DIVIDEND - Dividend payout. - CONTRIBUTION - Cash
contribution. - WITHDRAWAL - Cash withdrawal. - REI - Dividend reinvestment.
STOCK_DIVIDEND - A type of dividend where a company distributes shares
instead of cash - INTEREST - Interest deposited into the account. - FEE -
Fee withdrawn from the account. - OPTIONEXPIRATION - Option expiration event.OPTIONASSIGNMENT - Option assignment event. - OPTIONEXERCISE - Option
exercise event. - TRANSFER - Transfer of assets from one account to another/accounts/{accountId}/activities GET
snaptrade.account_information.get_all_user_holdingsDeprecated, please use the account-specific holdings endpoint instead.
List all accounts for the user, plus balances, positions, and orders for each account.
result = snaptrade.account_information.get_all_user_holdings(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
brokerage_authorizations: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
)
p result
StringStringStringOptional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
/holdings GET
snaptrade.account_information.get_user_account_balanceReturns 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.
result = snaptrade.account_information.get_user_account_balance(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
)
p result
StringStringString/accounts/{accountId}/balances GET
snaptrade.account_information.get_user_account_detailsReturns 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.
result = snaptrade.account_information.get_user_account_details(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
)
p result
StringStringString/accounts/{accountId} GET
snaptrade.account_information.get_user_account_order_detailReturns the detail of a single order in the specified account.
This endpoint is always realtime and does not rely on cached data.
This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
result = snaptrade.account_information.get_user_account_order_detail(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
)
p result
StringStringStringString/accounts/{accountId}/orders/{brokerageOrderId} GET
snaptrade.account_information.get_user_account_ordersReturns 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.
result = snaptrade.account_information.get_user_account_orders(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
state: "all",
days: 30,
)
p result
StringStringStringStringdefaults value is set to "all"
IntegerNumber of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
/accounts/{accountId}/orders GET
snaptrade.account_information.get_user_account_positionsReturns 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.
result = snaptrade.account_information.get_user_account_positions(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
)
p result
StringStringString/accounts/{accountId}/positions GET
snaptrade.account_information.get_user_account_recent_ordersA lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days By default only returns executed orders, but that can be changed by setting only_executed to false Please contact support for access as this endpoint is not enabled by default.
result = snaptrade.account_information.get_user_account_recent_orders(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
only_executed: true,
)
p result
StringStringStringBooleanDefaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
/accounts/{accountId}/recentOrders GET
snaptrade.account_information.get_user_account_return_ratesReturns a list of rate of return percents for a given account. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
result = snaptrade.account_information.get_user_account_return_rates(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
)
p result
StringStringString/accounts/{accountId}/returnRates GET
snaptrade.account_information.get_user_holdingsReturns 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.
result = snaptrade.account_information.get_user_holdings(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringStringString/accounts/{accountId}/holdings GET
snaptrade.account_information.list_user_accountsReturns all brokerage accounts across all connections 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.
result = snaptrade.account_information.list_user_accounts(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringString/accounts GET
snaptrade.account_information.update_user_accountUpdates various properties of a specified account.
result = snaptrade.account_information.update_user_account(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "accountId_example",
)
p result
StringStringStringThe ID of the account to update.
/accounts/{accountId} PUT
snaptrade.api_status.checkCheck whether the API is operational and verify timestamps.
result = snaptrade.api_status.check
p result
/ GET
snaptrade.authentication.delete_snap_trade_userDeletes 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.
result = snaptrade.authentication.delete_snap_trade_user(
user_id: "snaptrade-user-123",
)
p result
String/snapTrade/deleteUser DELETE
snaptrade.authentication.list_snap_trade_usersReturns a list of all registered user IDs. Please note that the response is not currently paginated.
result = snaptrade.authentication.list_snap_trade_users
p result
/snapTrade/listUsers GET
snaptrade.authentication.login_snap_trade_userAuthenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check this guide for how to integrate the Connection Portal into your app.
Please note that the returned URL expires in 5 minutes.
result = snaptrade.authentication.login_snap_trade_user(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
broker: "ALPACA",
immediate_redirect: true,
custom_redirect: "https://snaptrade.com",
reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
connection_type: "read",
connection_portal_version: "v4",
)
p result
StringStringStringSlug of the brokerage to connect the user to. See the integrations page for a list of supported brokerages and their slugs.
BooleanWhen 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.
StringURL 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.
StringThe 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.
ConnectionTypeSets whether the connection should be read-only or trade-enabled. Defaults to read-only if not specified.
ConnectionPortalVersionSets the connection portal version to render. Currently only v4 is supported and is the default. All other versions are deprecated and will automatically be set to v4.
AuthenticationLoginSnapTradeUser200Response
/snapTrade/login POST
snaptrade.authentication.register_snap_trade_userRegisters a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
result = snaptrade.authentication.register_snap_trade_user(
user_id: "snaptrade-user-123",
)
p result
StringSnapTrade 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.
/snapTrade/registerUser POST
snaptrade.authentication.reset_snap_trade_user_secretRotates 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.
result = snaptrade.authentication.reset_snap_trade_user_secret(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringSnapTrade 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.
StringSnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.
/snapTrade/resetUserSecret POST
snaptrade.connections.detail_brokerage_authorizationReturns a single connection for the specified ID.
result = snaptrade.connections.detail_brokerage_authorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringStringString/authorizations/{authorizationId} GET
snaptrade.connections.disable_brokerage_authorizationManually force the specified connection to become disabled. 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.
This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
result = snaptrade.connections.disable_brokerage_authorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringStringStringBrokerageAuthorizationDisabledConfirmation
/authorizations/{authorizationId}/disable POST
snaptrade.connections.list_brokerage_authorizationsReturns a list of all connections for the specified user. Note that Connection and Brokerage Authorization are interchangeable, but the term Connection is preferred and used in the doc for consistency.
A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.
SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
result = snaptrade.connections.list_brokerage_authorizations(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringString/authorizations GET
snaptrade.connections.refresh_brokerage_authorizationTrigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes for each account under the connection.
This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.
Because of the cost of refreshing a connection, each call to this endpoint incurs a additional charge based on your Pricing Plan
result = snaptrade.connections.refresh_brokerage_authorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
p result
StringStringStringBrokerageAuthorizationRefreshConfirmation
/authorizations/{authorizationId}/refresh POST
snaptrade.connections.remove_brokerage_authorizationDeletes the connection specified by the ID. This will also delete all accounts and holdings associated with the connection. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the connection has been successfully deleted.
snaptrade.connections.remove_brokerage_authorization(
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
)
StringStringString/authorizations/{authorizationId} DELETE
snaptrade.connections.return_ratesReturns a list of rate of return percents for a given connection. Will include timeframes available from the brokerage, for example "ALL", "1Y", "6M", "3M", "1M"
result = snaptrade.connections.return_rates(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
authorization_id: "87b24961-b51e-4db8-9226-f198f6518a89",
)
p result
StringStringString/authorizations/{authorizationId}/returnRates GET
snaptrade.connections.session_eventsReturns a list of session events associated with a user.
result = 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",
)
p result
StringStringOptional comma separated list of user IDs used to filter the request on specific users
StringOptional comma separated list of session IDs used to filter the request on specific users
ConnectionsSessionEvents200ResponseInner
/sessionEvents GET
snaptrade.options.get_options_chainReturns the option chain for the specified symbol in the specified account.
result = snaptrade.options.get_options_chain(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "accountId_example",
symbol: "symbol_example",
)
p result
StringStringStringThe ID of the account to get the options chain from.
StringUniversal symbol ID if symbol
/accounts/{accountId}/optionsChain GET
snaptrade.options.list_option_holdingsReturns 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.
result = snaptrade.options.list_option_holdings(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
)
p result
StringStringString/accounts/{accountId}/options GET
snaptrade.reference_data.get_currency_exchange_rate_pairReturns an Exchange Rate Pair object for the specified Currency Pair.
result = snaptrade.reference_data.get_currency_exchange_rate_pair(
currency_pair: "currencyPair_example",
)
p result
StringA currency pair based on currency code for example, {CAD-USD}
/currencies/rates/{currencyPair} GET
snaptrade.reference_data.get_partner_infoReturns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
result = snaptrade.reference_data.get_partner_info
p result
/snapTrade/partners GET
snaptrade.reference_data.get_security_typesReturn all available security types supported by SnapTrade.
result = snaptrade.reference_data.get_security_types
p result
/securityTypes GET
snaptrade.reference_data.get_stock_exchangesReturns a list of all supported Exchanges.
result = snaptrade.reference_data.get_stock_exchanges
p result
/exchanges GET
snaptrade.reference_data.get_symbolsReturns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
result = snaptrade.reference_data.get_symbols(
substring: "AAPL",
)
p result
StringThe search query for symbols.
/symbols POST
snaptrade.reference_data.get_symbols_by_tickerReturns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
result = snaptrade.reference_data.get_symbols_by_ticker(
query: "query_example",
)
p result
StringThe ticker or Universal Symbol ID to look up the symbol with.
/symbols/{query} GET
snaptrade.reference_data.list_all_brokerage_authorization_typeReturns a list of all defined Brokerage authorization Type objects.
result = snaptrade.reference_data.list_all_brokerage_authorization_type(
brokerage: "QUESTRADE,ALPACA",
)
p result
StringComma separated value of brokerage slugs
BrokerageAuthorizationTypeReadOnly
/brokerageAuthorizationTypes GET
snaptrade.reference_data.list_all_brokerage_instrumentsReturns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
result = snaptrade.reference_data.list_all_brokerage_instruments(
brokerage_id: "87b24961-b51e-4db8-9226-f198f6518a89",
)
p result
String/brokerages/{brokerageId}/instruments GET
snaptrade.reference_data.list_all_brokeragesReturns a list of all defined Brokerage objects.
result = snaptrade.reference_data.list_all_brokerages
p result
/brokerages GET
snaptrade.reference_data.list_all_currenciesReturns a list of all defined Currency objects.
result = snaptrade.reference_data.list_all_currencies
p result
/currencies GET
snaptrade.reference_data.list_all_currencies_ratesReturns a list of all Exchange Rate Pairs for all supported Currencies.
result = snaptrade.reference_data.list_all_currencies_rates
p result
/currencies/rates GET
snaptrade.reference_data.symbol_search_user_accountReturns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
The search results are further limited to the symbols supported by the brokerage for which the account is under.
result = snaptrade.reference_data.symbol_search_user_account(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
substring: "AAPL",
)
p result
StringStringStringStringThe search query for symbols.
/accounts/{accountId}/symbols POST
snaptrade.trading.cancel_orderCancels an order in the specified account. Accepts order IDs for all asset types.
result = snaptrade.trading.cancel_order(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
)
p result
StringStringStringStringOrder ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
/accounts/{accountId}/trading/cancel POST
snaptrade.trading.cancel_user_account_order**This endpoint is deprecated. Please switch to the new cancel order endpoint ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
result = snaptrade.trading.cancel_user_account_order(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
)
p result
StringStringStringStringOrder ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
/accounts/{accountId}/orders/cancel POST
snaptrade.trading.get_cryptocurrency_pair_quoteGets a quote for the specified account.
result = snaptrade.trading.get_cryptocurrency_pair_quote(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
instrument_symbol: "BTC-USD",
)
p result
StringStringStringString/accounts/{accountId}/trading/instruments/cryptocurrencyPairs/{instrumentSymbol}/quote GET
snaptrade.trading.get_order_impactSimulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a Trade object and the ID of the object can be used to place the order with the brokerage using the place checked order endpoint. Please note that the Trade object returned expires after 5 minutes. Any order placed using an expired Trade will be rejected.
result = snaptrade.trading.get_order_impact(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
action: "BUY",
universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
order_type: "Market",
time_in_force: "Day",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
price: 31.33,
stop: 31.33,
units: 10.5,
notional_value: None,
)
p result
StringUnique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
ActionStrictThe action describes the intent or side of a trade. This is either BUY or
SELL.
StringUnique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
OrderTypeStrictThe type of order to place. - For Limit and StopLimit orders, the price
field is required. - For Stop and StopLimit orders, the stop field is
required.
TimeInForceStrictThe Time in Force type for the order. This field indicates how long the order
will remain active before it is executed or expires. Here are the supported
values: - Day - Day. The order is valid only for the trading day on which it
is placed. - 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.
StringStringFloatThe limit price for Limit and StopLimit orders.
FloatThe price at which a stop order is triggered for Stop and StopLimit orders.
FloatManualTradeFormNotionalValue/trade/impact POST
snaptrade.trading.get_user_account_quotesReturns quotes from the brokerage for the specified symbols and account.
The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
This endpoint does not work for options quotes.
This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
result = snaptrade.trading.get_user_account_quotes(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
symbols: "symbols_example",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
use_ticker: true,
)
p result
StringStringStringList of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
StringBooleanShould be set to True if symbols are comprised of tickers. Defaults to
False if not provided.
/accounts/{accountId}/quotes GET
snaptrade.trading.place_bracket_orderPlaces a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
result = snaptrade.trading.place_bracket_order(
action: "BUY",
instrument: {
"symbol" => "AAPL",
"type" => "EQUITY",
},
order_type: "Market",
time_in_force: "Day",
stop_loss: {
"stop_price" => "48.55",
"limit_price" => "48.50",
},
take_profit: {
"limit_price" => "49.95",
},
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
symbol: "AAPL",
price: 31.33,
stop: 31.33,
units: 10.5,
)
p result
ActionStrictWithOptionsThe action describes the intent or side of a trade. This is either BUY or
SELL for Equity symbols or BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OPEN or
SELL_TO_CLOSE for Options.
TradingInstrumentOrderTypeStrictThe type of order to place. - For Limit and StopLimit orders, the price
field is required. - For Stop and StopLimit orders, the stop field is
required.
TimeInForceStrictThe Time in Force type for the order. This field indicates how long the order
will remain active before it is executed or expires. Here are the supported
values: - Day - Day. The order is valid only for the trading day on which it
is placed. - 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.
StopLossTakeProfitStringThe ID of the account to execute the trade on.
StringStringStringThe security's trading ticker symbol.
FloatThe limit price for Limit and StopLimit orders.
FloatThe price at which a stop order is triggered for Stop and StopLimit orders.
FloatNumber of shares for the order. This can be a decimal for fractional orders.
Must be null if notional_value is provided.
/accounts/{accountId}/trading/bracket POST
snaptrade.trading.place_crypto_orderPlaces an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
result = snaptrade.trading.place_crypto_order(
instrument: {
"symbol" => "BTC",
"type" => "CRYPTOCURRENCY",
},
side: "BUY",
type: "MARKET",
time_in_force: "GTC",
amount: "123.45",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "123.45",
stop_price: "123.45",
post_only: false,
expiration_date: "2024-01-01T00:00:00Z",
)
p result
CryptoTradingInstrumentActionStrictThe action describes the intent or side of a trade. This is either BUY or
SELL.
CryptoOrderFormTypeThe type of order to place.
CryptoOrderFormTimeInForceThe 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.
FloatThe amount of the base currency to buy or sell.
StringStringStringFloatThe limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
FloatThe stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
BooleanValid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
TimeThe expiration date of the order. Required if the time_in_force is GTD.
/accounts/{accountId}/trading/crypto POST
snaptrade.trading.place_force_orderPlaces a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds.
This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the check order impact endpoint.
It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the manual refresh endpoint for this.
result = snaptrade.trading.place_force_order(
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
action: "BUY",
order_type: "Market",
time_in_force: "Day",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
universal_symbol_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
symbol: "AAPL",
price: 31.33,
stop: 31.33,
units: 10.5,
notional_value: None,
)
p result
StringUnique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
ActionStrictWithOptionsThe action describes the intent or side of a trade. This is either BUY or
SELL for Equity symbols or BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OPEN or
SELL_TO_CLOSE for Options.
OrderTypeStrictThe type of order to place. - For Limit and StopLimit orders, the price
field is required. - For Stop and StopLimit orders, the stop field is
required.
TimeInForceStrictThe Time in Force type for the order. This field indicates how long the order
will remain active before it is executed or expires. Here are the supported
values: - Day - Day. The order is valid only for the trading day on which it
is placed. - 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.
StringStringStringThe universal symbol ID of the security to trade. Must be 'null' if symbol is
provided, otherwise must be provided.
StringThe security's trading ticker symbol. If 'symbol' is provided, then 'universal_symbol_id' must be 'null'.
FloatThe limit price for Limit and StopLimit orders.
FloatThe price at which a stop order is triggered for Stop and StopLimit orders.
FloatFor Equity orders, this represents the number of shares for the order. This can
be a decimal for fractional orders. Must be null if notional_value is
provided. If placing an Option order, this field represents the number of
contracts to buy or sell. (e.g., 1 contract = 100 shares).
ManualTradeFormNotionalValue/trade/place POST
snaptrade.trading.place_mleg_orderPlaces a multi-leg option order. Only supported on certain option trading brokerages. https://snaptrade.notion.site/brokerages has information on brokerage trading support
result = snaptrade.trading.place_mleg_order(
order_type: "MARKET",
time_in_force: "Day",
legs: [
{
"instrument" => {
"symbol" => "PBI 250718C00006000",
"instrument_type" => "OPTION",
},
"action" => "BUY_TO_OPEN",
"units" => 1,
}
],
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "",
stop_price: "",
price_effect: "DEBIT",
)
p result
MlegOrderTypeStrictThe type of order to place.
TimeInForceStrictThe Time in Force type for the order. This field indicates how long the order
will remain active before it is executed or expires. Here are the supported
values: - Day - Day. The order is valid only for the trading day on which it
is placed. - 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.
MlegLeg>StringStringStringFloatThe limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT.
FloatThe stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT.
MlegPriceEffectStrict/accounts/{accountId}/trading/options POST
snaptrade.trading.place_orderPlaces the previously checked order with the brokerage. The tradeId is obtained from the check order impact endpoint. If you prefer to place the order without checking for impact first, you can use the place order endpoint.
It's recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the manual refresh endpoint for this.
result = snaptrade.trading.place_order(
trade_id: "139e307a-82f7-4402-b39e-4da7baa87758",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
wait_to_confirm: true,
)
p result
StringObtained from calling the check order impact endpoint
StringStringBooleanOptional, 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.
/trade/{tradeId} POST
snaptrade.trading.preview_crypto_orderPreviews an order using the specified account.
result = snaptrade.trading.preview_crypto_order(
instrument: {
"symbol" => "BTC",
"type" => "CRYPTOCURRENCY",
},
side: "BUY",
type: "MARKET",
time_in_force: "GTC",
amount: "123.45",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
limit_price: "123.45",
stop_price: "123.45",
post_only: false,
expiration_date: "2024-01-01T00:00:00Z",
)
p result
CryptoTradingInstrumentActionStrictThe action describes the intent or side of a trade. This is either BUY or
SELL.
CryptoOrderFormTypeThe type of order to place.
CryptoOrderFormTimeInForceThe 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.
FloatThe amount of the base currency to buy or sell.
StringStringStringFloatThe limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
FloatThe stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
BooleanValid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
TimeThe expiration date of the order. Required if the time_in_force is GTD.
/accounts/{accountId}/trading/crypto/preview POST
snaptrade.trading.replace_orderReplaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order's brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
result = snaptrade.trading.replace_order(
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
action: "BUY",
order_type: "Market",
time_in_force: "Day",
account_id: "2bcd7cc3-e922-4976-bce1-9858296801c3",
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
price: 31.33,
symbol: "AAPL",
stop: 31.33,
units: 10.5,
)
p result
StringOrder ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
ActionStrictThe action describes the intent or side of a trade. This is either BUY or
SELL.
OrderTypeStrictThe type of order to place. - For Limit and StopLimit orders, the price
field is required. - For Stop and StopLimit orders, the stop field is
required.
TimeInForceStrictThe Time in Force type for the order. This field indicates how long the order
will remain active before it is executed or expires. Here are the supported
values: - Day - Day. The order is valid only for the trading day on which it
is placed. - 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.
StringThe ID of the account to execute the trade on.
StringStringFloatThe limit price for Limit and StopLimit orders.
StringThe security's trading ticker symbol
FloatThe price at which a stop order is triggered for Stop and StopLimit orders.
Float/accounts/{accountId}/trading/replace POST
snaptrade.trading.search_cryptocurrency_pair_instrumentsSearches cryptocurrency pairs instruments accessible to the specified account.
result = snaptrade.trading.search_cryptocurrency_pair_instruments(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
account_id: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
base: "BTC",
quote: "USD",
)
p result
StringStringStringStringStringTradingSearchCryptocurrencyPairInstruments200Response
/accounts/{accountId}/trading/instruments/cryptocurrencyPairs GET
snaptrade.transactions_and_reporting.get_activitiesThis endpoint is being deprecated but will continue to be available for use via SDKs, please use the account level endpoint if possible
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.
result = snaptrade.transactions_and_reporting.get_activities(
user_id: "snaptrade-user-123",
user_secret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
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",
)
p result
StringStringDateThe 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.
DateThe 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.
StringOptional 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.
StringOptional 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.
StringOptional 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 - Asset bought. -
SELL - Asset sold. - DIVIDEND - Dividend payout. - CONTRIBUTION - Cash
contribution. - WITHDRAWAL - Cash withdrawal. - REI - Dividend reinvestment.
INTEREST - Interest deposited into the account. - FEE - Fee withdrawn from
the account. - OPTIONEXPIRATION - Option expiration event. -
OPTIONASSIGNMENT - Option assignment event. - OPTIONEXERCISE - Option
exercise event. - TRANSFER - Transfer of assets from one account to another/activities GET
snaptrade.transactions_and_reporting.get_reporting_custom_rangeReturns 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.
result = 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: "adf2aa34-8219-40f7-a6b3-60156985cc61",
accounts: "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
detailed: true,
frequency: "monthly",
)
p result
DateDateStringStringStringOptional comma separated list of account IDs used to filter the request on specific accounts
BooleanOptional, increases frequency of data points for the total value and contribution charts if set to true
StringOptional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
/performance/custom GET
This TypeScript package is automatically generated by Konfig
FAQs
Unknown package
We found that snaptrade demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.
Security News
CISA’s 2025 draft SBOM guidance adds new fields like hashes, licenses, and tool metadata to make software inventories more actionable.