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.

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

Your API key consists of a clientId and consumerKey. 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, you will need to create your free and paid API keys. You may create only your free key if preferred.

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.

After completing these steps, you will 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 two 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. You can use these API keys to make requests to the SnapTrade API.

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
   Get API Status

   get
   .
2. Press ‘Send’.

In the box below the ‘request’ you should receive a response from the SnapTrade API. The

Get API Status

get

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 don’t officially support custom setups without an SDK, you can copy the signature generation logic from any of our SDKs if you want to go that route.

SnapTrade SDKs

API Keys FAQ

Users

Your API key will be used to 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.

Typically if you have an 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

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

1. Using your API Key, create a request to the
   Register user

   post
   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

List all users

get

endpoint, and you can delete created users by using the

Delete user

delete

endpoint. If needed, you may reset a user’s userSecret by using the

Rotate user secret

post

endpoint. Now that you have one or more SnapTrade users under your API Key, you are ready to create connections under these users.

Users FAQ

Connections

Each user under your SnapTrade API key will be used to create and manage connections associated with that user. 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 have a SnapTrade user and want to get access to their account data and/or place trades for an account, you will need to create a connection for that user.

1. Generate a new redirectURI for the SnapTrade Connection Portal using
   Generate Connection Portal URL

   post
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

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, use the
   List accounts

   get
   endpoint to get the accountId of the account you wish to pull positions for.
2. With the accountId, call
   List account positions

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

List account balances

get

and

List account orders

get

.

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
   Get equity symbol quotes

   get
   .
2. Validate the order with
   Check equity order impact

   post
   . 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 your 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
   Check equity order impact

   post
   , place the checked order using
   Place checked equity order

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

List account orders

get

endpoint. If it does not, you may need to trigger a refresh for the connection using

Refresh holdings for a connection

post

.

Accounts FAQ

Next Steps

• To get started with Webhooks, see Webhooks
• To get started with implementing the SnapTrade Connection Portal, see Methods to Integrate the Connection Portal into Your Application