SnapTrade

Getting Started

1) Initialize a client with your clientId and consumerKey

You can get your clientId and consumerKey by contacting api@snaptrade.com

2) Check that the client is able to make a request to the API server

Call the API Status endpoint to make sure the API is live and that you can make the most basic request. You should receive a response indicating the API status, current server timestamp, and internal API minor version number.

3) Create a new user on SnapTrade

To create a secure brokerage authorization, we first need to register a test user. Call the Register user endpoint with a userId which can be any string as long as it's unique to a user. Upon receiving a 200 response, the user is registered successfully and you should receive a response with a user id and a randomly generated user secret. You can think of the user secret like a per-user API key that provides an additional layer of security for protecting user data. The user id and user secret need to be passed along to all SnapTrade API endpoints that involve access to user data.

4) Get a redirect URI

SnapTrade partners need to generate a redirect URI for a user so they can securely log in to the SnapTrade Connection portal and connect their accounts. The redirect URI can be generated by sending a POST request to the Login endpoint. userId and userSecret (previously generated through calling the registerUser endpoint) have to be in the query parameters of the POST request. The response would indicate a redirectURI to be used for login a user to the SnapTrade portal.

5) List accounts

After connecting an account to snaptrade, you can see the account IDs by calling list_user_accounts.

6) Get account holdings data for a user

In order to retrieve user holdings for a specific account, you can call the Holdings endpoint by passing the clientId, timestamp, userId and list of account numbers (accounts) to filter the holdings. In the response, you should get an array of objects containing each account holdings data.