For AI agents: the complete documentation index is available at https://docs.snaptrade.com/llms.txt, and the full documentation text is available at https://docs.snaptrade.com/llms-full.txt. Markdown versions of documentation pages are available by appending .md to the URL path.
logo
Book A Demo
Book A Demo
View as Markdown
Guides

Getting Started with SnapTrade

Introduction

Welcome to SnapTrade! This is intended to be one of the first documents you read when learning how to use the SnapTrade API and will answer many questions you might have while getting started. This document when read from top-to-bottom is also a guide for making your first connection, and will get you set up to start pulling account data and placing trades.

If you want a quick definitions reference while reading, see Terminology.

If you are unsure whether to build as an individual user or as an app with many end users, see SnapTrade Personal vs Commercial.

For a focused reference on Commercial credentials and Personal API keys, see Authentication Methods.

Please see the FAQ of each section, as any questions you might have should be answered there.

If after reading this document you still have questions or need help, please do not hesitate to contact us through our Discord.

For a live demo, see the Getting Started Demo.

API Keys

image.png

Your API key consists of a clientId and consumerKey. SnapTrade supports both Personal API keys, which represent the signed-in SnapTrade user directly, and Commercial API keys, which let an application manage SnapTrade users for its own end users. Please note that your consumerKey is sensitive information and should be kept secure at all times. This API key is used to make any requests to the SnapTrade API, and is the first thing required to get started.

How to: Create a new API Key

When you are ready to get started with SnapTrade and want to start making requests to our API, create the API key that matches your use case. Personal users can create a Personal API key for their own accounts. Commercial integrations can create test and, after approval, production API keys for apps that manage end users.

  1. Create a SnapTrade account at the SnapTrade Dashboard.
  2. Verify your email (You cannot create any API Keys until your account is verified).
  3. Generate your free API Key through the SnapTrade Dashboard.
  4. [OPTIONAL] Add a payment method through the Settings > Billing page of the SnapTrade Dashboard.
  5. [OPTIONAL] Upgrade to Pay-as-you-Go through Settings > Billing page of the SnapTrade Dashboard.
  6. [OPTIONAL] Generate your paid API Key through the SnapTrade Dashboard.

For Commercial accounts, after completing these steps, you may have two SnapTrade API Keys:

  • A free API Key that limits the number of concurrent connections.
  • Optionally, a paid API Key that allows for unlimited connections.

These Commercial API keys are essentially the same in terms of functionality, and the core difference between them is that the free API key is limited in terms of the number of concurrent connections you can have. Personal API keys instead represent the Personal account owner directly and do not require creating SnapTrade users.

How to: Make a request to the SnapTrade API

When you have an API Key and want to start using the SnapTrade API, you will need to use your API Key to make requests to the SnapTrade API.

  1. With your Free API Key, enter your clientId and consumerKey into the corresponding fields of .
  2. Press ‘Send’.

In the box below the ‘request’ you should receive a response from the SnapTrade API. The endpoint is the most basic request you can make to the SnapTrade API.

You can also make this request with any of the SnapTrade SDKs. While we recommend using an SDK, custom direct API integrations can generate signatures by following Request Signatures.

SnapTrade SDKs

LanguageSDK Link
Pythonhttps://pypi.org/project/snaptrade-python-sdk
TypeScripthttps://www.npmjs.com/package/snaptrade-typescript-sdk
Javahttps://central.sonatype.com/artifact/com.snaptrade/snaptrade-java-sdk
Rubyhttps://rubygems.org/gems/snaptrade
C#https://nuget.org/packages/SnapTrade.Net
PHPhttps://packagist.org/packages/konfig/snaptrade-php-sdk
Gohttps://pkg.go.dev/github.com/passiv/snaptrade-sdks/sdks/go

API Keys FAQ

Users

image.png

This section applies to Commercial API keys. A Commercial API key can manage a set of SnapTrade users. A SnapTrade user consists of a userId and a userSecret. The userSecret is a randomly generated string and is sensitive information. It should be kept secure at all times.

Personal API key users do not create or manage SnapTrade users, and should skip this section. With Personal API key authentication, the API key represents the authenticated SnapTrade user directly; omit userId and userSecret when making API requests.

Typically if you have a Commercial application that manages end-users, each end-user of your application will get one SnapTrade user that will be used to manage that end-user’s connections. This way, SnapTrade users will be one-to-one with the end-users of your application.

How to: Create a new SnapTrade User (Commercial only)

When you have a working Commercial API Key and want to create a new connection for an app user, you will first need to register a SnapTrade user.

  1. Using your Commercial API Key, create a request to the endpoint. You will need to provide a unique SnapTrade userId . This can be anything that is immutable. For this reason, it is recommended to NOT use email addresses for a SnapTrade userId.
  2. The response you receive from the SnapTrade API will contain the userId you provided and the userSecret generated by SnapTrade. The userSecret is a randomly generated string and is sensitive information.

You can list your created users by using the endpoint, and you can delete created users by using the endpoint. If needed, you may reset a user’s userSecret by using the endpoint. Now that you have one or more SnapTrade users under your Commercial API Key, you are ready to create connections under these users.

Users FAQ

Connections

image.png

For Commercial API keys, each SnapTrade user under your API key is used to create and manage connections associated with that user. For Personal API keys, the authenticated Personal user is the connection owner, so you do not send userId or userSecret. Each connection is associated one-to-one with a set of credentials to an institution.

How to: Create a new connection for a user

When you want to get access to account data and/or place trades for an account, create a connection for the relevant SnapTrade user context.

  1. Generate a new redirectURI for the SnapTrade Connection Portal using . Commercial requests use the SnapTrade userId and userSecret; Personal API key requests use the authenticated self context and omit those fields.
  2. Open the generated link. Depending on your application, there are different ways to open this link. See Methods to Integrate the Connection Portal into Your Application.

Once you have successfully completed the Connection Portal Flow, you should have an active connection to work with, and should have access to the accounts under that connection.

Connections FAQ

Accounts

image.png

When you create a connection, SnapTrade will automatically sync all accounts under the set of credentials to the brokerage. For example, if you made a new connection to Questrade (a Canadian brokerage) and that connection had a TFSA, an RRSP and an FHSA account under those credentials, SnapTrade would make all these accounts accessible over the SnapTrade API.

Once you have a connected account, you are ready to move on to pulling account data, and placing trades for that account.

How to: Get positions for an account

When you have at least one connected account and want to start making use of the positions, you will first need to get the accountId.

  1. You can find the accountId anywhere over the API where the account object is returned. In this example, call to list the user's connections, then call for the relevant connection to get the accountId of the account you wish to pull positions for.
  2. With the accountId, call . This will return a list of positions in the specified account.

Once you have positions returned, you’re able to make use of the data in analysis, monitoring, or another use-case you might be interested in. Other core endpoints for retrieving account information include and .

How to: Place a checked trade for an account

When you have at least one connected account and want to place a trade in the account, you will need to follow these steps to place a checked order. Note that you may also place an order without checking it.

  1. You need to get the universalSymbolId for the instrument that you wish to place an order for. You can find this using .
  2. Validate the order with . This is a safe way to check the impact that the trade will have on the account if it is executed, and this is recommended to show on a screen to the account owner or end user to have them confirm the order. Save the tradeId returned by this endpoint, it will be used in the next step. This tradeId will expire after a few minutes.
  3. Using the tradeId returned from , place the checked order using . This will place the order at the brokerage for the account, and return the response given by the broker.

The order will now show over the endpoint. If it does not, you may need to trigger a refresh for the connection using .

Accounts FAQ

image.png

Next Steps

Edit this page
Made with Konfig