  Getting Started with SnapTrade  This guide will help you connect a brokerage account  retrieve account data  and  where enabled  place a trade  Start by choosing the customer model that matches who will use the integration   For definitions used throughout this guide  see  Terminology  https   docs snaptrade com docs terminology   For more detail about the two customer models  see  SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial  and  Authentication Methods  https   docs snaptrade com docs authentication methods    The  interactive Getting Started Demo  https   docs snaptrade com demo getting started  currently demonstrates the Commercial flow         a id  getting started api keys    a      Choose a Customer Model  Personal users can share their connected brokerage data with OAuth enabled apps or access it directly with a Personal API key  Commercial integrations either use an API key to manage brokerage accounts for their end users or register an OAuth app that end users authorize to access the accounts they manage in SnapTrade Personal       Personal   Commercial                         Use when   You are accessing your own brokerage accounts   Your application manages brokerage accounts for its end users     Access methods   OAuth for sharing data  or a Personal API key for direct access   An OAuth app  or a Commercial API key     User identity   Your signed in SnapTrade account identifies you   OAuth  each app user s access token  API key  each app user has a SnapTrade  userId  and  userSecret      User registration   Not required   OAuth  not required  API key  required before connecting a brokerage     Trading   Available through Personal API keys where enabled  OAuth trading is in beta   Available through Commercial API keys where enabled  OAuth trading is in beta     Webhooks   Available for Personal API keys   Available       Follow the Personal quickstart   personal quickstart     Follow the Commercial quickstart   commercial quickstart       SnapTrade SDKs  We recommend using a SnapTrade SDK  If you call the API directly  follow  Request Signatures  https   docs snaptrade com docs request signatures  to sign each request       Language       SDK Link                     Python      https   pypi org project snaptrade python sdk    https   pypi org project snaptrade python sdk      TypeScript      https   www npmjs com package snaptrade typescript sdk    https   www npmjs com package snaptrade typescript sdk      Java      https   central sonatype com artifact com snaptrade snaptrade java sdk    https   central sonatype com artifact com snaptrade snaptrade java sdk      Ruby      https   rubygems org gems snaptrade    https   rubygems org gems snaptrade      C       https   nuget org packages SnapTrade Net    https   nuget org packages SnapTrade Net      PHP      https   packagist org packages konfig snaptrade php sdk    https   packagist org packages konfig snaptrade php sdk      Go      https   pkg go dev github com passiv snaptrade sdks sdks go    https   pkg go dev github com passiv snaptrade sdks sdks go           a id  personal quickstart    a      Personal Quickstart  Use this path when you are connecting and managing your own brokerage accounts        Add the Personal account    brokerage connections    OAuth apps or Personal API key diagram here           1  Create a Personal Account  1  Create a Personal account in the  SnapTrade Dashboard  https   dashboard snaptrade com home   2  Verify your email       2  Choose How to Access Your Data  Most Personal users connect their brokerage accounts in the SnapTrade Dashboard and share that data with apps through OAuth  You can also create a Personal API key when you want to access your data programmatically        Share Your Data Through OAuth  1  Connect and manage your brokerage accounts in the  SnapTrade Dashboard  https   dashboard snaptrade com home   2  In an OAuth enabled app or AI assistant  choose SnapTrade as a data source  3  Sign in to SnapTrade and approve the access the app requests   The app receives a scoped OAuth token instead of your Personal API credentials  Do not give an app your  consumerKey   OAuth supports reading account data and managing connections  Trading through OAuth is in beta  an app that requests the  trade  permission can place  modify  and cancel orders in accounts where your brokerage connection supports trading   To share data with an AI assistant  see the  SnapTrade MCP Server  https   docs snaptrade com docs mcp server   Developers building an app that receives shared data should see  Build an OAuth App  https   docs snaptrade com docs oauth apps         Access Your Data With a Personal API Key  1  Enable two factor authentication in the SnapTrade Dashboard  2  Create your Personal API key from the  API Key page  https   dashboard snaptrade com api key   3  Store the  clientId  and  consumerKey  securely   Your Personal API key represents you  Do not register a separate SnapTrade user  and do not send a  userId  or  userSecret  in Personal API requests    a id  getting started connections    a       3  Connect a Brokerage With Your API Key  If you already connected your brokerage account in the Dashboard  you can skip this step  To add another connection programmatically   1  Open  api Authentication loginSnapTradeUser  and select   Personal API Key   authentication  2  Enter your Personal  clientId  and  consumerKey   Leave  userId  and  userSecret  unset  3  If you intend to trade  set  connectionType  to  trade if available   The default  read  connection type supports data access only  4  Send the request and open the returned Connection Portal URL  5  Complete the Connection Portal flow for your brokerage   A  connection  represents a linked set of brokerage credentials  Completing the portal flow makes the brokerage accounts under that connection available through SnapTrade   For more ways to open and configure the portal  see  Methods to Integrate the Connection Portal into Your Application  https   docs snaptrade com docs implement connection portal     a id  getting started accounts    a       4  Retrieve Accounts and Positions  1  Call  api AccountInformation listUserAccounts  using   Personal API Key   authentication to list your accounts  2  Choose the  accountId  for the account you want to inspect  3  Call  api AccountInformation getAllAccountPositions  with that  accountId    You can also retrieve balances with  api AccountInformation getUserAccountBalance  and orders with  api AccountInformation getUserAccountOrders        5  Place an Equity Trade  Personal users can trade their own accounts when trading is enabled for the API key  brokerage  connection  and account   1  Build the order using the account ID and the brokerage ticker in the  symbol  field  2  Validate the order details and confirm them before submission  3  Call  api Trading placeForceOrder  to submit the order to the brokerage   Use   Personal API Key   authentication throughout and continue to omit  userId  and  userSecret    For order types  brokerage support  and other asset classes  see  Trading with SnapTrade  https   docs snaptrade com docs trading with snaptrade        Personal Next Steps    Learn more about retrieving  Account Data  https   docs snaptrade com docs account data     Learn how to manage and repair  Connections  https   docs snaptrade com docs connections     Configure  Webhooks  https   docs snaptrade com docs webhooks     Access your data through AI assistants with the  SnapTrade MCP Server  https   docs snaptrade com docs mcp server     Back to customer models   getting started api keys         a id  commercial quickstart    a      Commercial Quickstart  Use this path when you are building an application for your own end users  Choose how your app accesses their brokerage data       OAuth app   Commercial API key                         End users   Sign in with their SnapTrade account   Your app registers a SnapTrade user for each one     Brokerage connections   Already connected in SnapTrade  users grant your app access   Your app builds the connection flow with the Connection Portal     Broker access   All brokers supported by SnapTrade Personal  available immediately   Some brokers require separate approval before launch  see the  Broker Access Guide  https   docs snaptrade com docs broker access guide      Per user credentials   Tokens issued when the user approves access   A  userId  and  userSecret  your app stores for each user     Request authentication   Standard Bearer token   Each request signed with your  consumerKey      Trading   In beta  with the  trade  scope   Available where enabled     Pricing   Free during the limited time OAuth preview   Per user pricing  see  Billing  https   docs snaptrade com docs billing        Build with OAuth   commercial oauth quickstart     Build with a Commercial API key   commercial api key quickstart    a id  commercial oauth quickstart    a       Option 1  Build With OAuth  With OAuth  users bring the brokerage accounts they already manage in SnapTrade  and a single connection can be shared with every app they use  Your app does not register SnapTrade users  store  userSecret  values  sign requests  or embed the Connection Portal        Add the OAuth app    user consent    tokens    accounts diagram here            1  Register an OAuth App  1  Create a Commercial account in the  SnapTrade Dashboard  https   dashboard snaptrade com home   2  Select   OAuth Apps   in the left sidebar  create a   Test   app  and add your redirect URIs  Production redirects must use HTTPS  local testing can use a loopback address such as  http   127 0 0 1   3  Save the  client id  and  client secret  on a secure backend  The secret is shown only once  4  When you are ready for production  complete the  Production Access Application  https   dashboard snaptrade com production access  and register a   Production   app   Test OAuth apps are limited to 5 users  To test the consent flow  use a SnapTrade Personal account with at least one brokerage connection        2  Send the User Through Authorization  1  Read the authorization server metadata from  https   api snaptrade com  well known oauth authorization server  to find the authorization  token  and revocation endpoints  2  Generate a fresh  state  and PKCE  code verifier  for the attempt  and derive an  S256   code challenge   3  Redirect the user to the authorization endpoint with  response type code   your  client id    redirect uri    state    code challenge    code challenge method S256   and  scope read   Add  trade  if your app places orders and  webhook  if it needs event notifications   The user signs in to SnapTrade  reviews the requested access  and approves or denies your app        3  Exchange the Code for Tokens  1  In your callback  reject the response if  state  does not match  and handle any  error  without exchanging a code  2  From your backend  exchange the  code  and  code verifier  at the token endpoint using HTTP Basic client authentication  3  Store the returned  access token  and  refresh token  encrypted and associated with the signed in user   Access tokens are valid for 10 hours  Refresh tokens rotate  each successful refresh returns a new refresh token that replaces the old one        4  Retrieve Accounts and Positions  Send the access token as a Bearer token  Do not include  clientId    consumerKey    userId    userSecret    timestamp   or  Signature  on OAuth requests      http GET https   api snaptrade com accounts Authorization  Bearer ACCESS TOKEN Accept  application json      1  Call  api AccountInformation listUserAccounts  to list the accounts the user shared  2  Choose the  accountId  for the account you want to inspect  3  Call  api AccountInformation getAllAccountPositions  with the  accountId    You can also retrieve balances with  api AccountInformation getUserAccountBalance  and orders with  api AccountInformation getUserAccountOrders   Users add  repair  and remove brokerage connections in the  SnapTrade Dashboard  https   dashboard snaptrade com         5  Place an Equity Trade  OAuth trading is in beta  Your app can trade when the user granted the  trade  scope and their brokerage connection supports trading   1  Build the order using the account ID and the brokerage ticker in the  symbol  field  2  Show the user the order details and have them confirm it  3  Call  api Trading placeForceOrder  with the Bearer token to submit the order to the brokerage   Users who authorized your app without  trade  must go through the authorization flow again to grant it   For token refresh  revocation  OpenID Connect sign in  webhooks  and a production checklist  see  Build an OAuth App  https   docs snaptrade com docs oauth apps     a id  commercial api key quickstart    a       Option 2  Build With a Commercial API Key  Use a Commercial API key when your app needs to create and manage SnapTrade users and their brokerage connections itself        Add the Commercial API key    users    connections    accounts diagram here            1  Create a Commercial API Key  1  Create a Commercial account in the  SnapTrade Dashboard  https   dashboard snaptrade com home   2  Verify your email  3  Enable two factor authentication  4  Create a test API key from the  API Key page  https   dashboard snaptrade com api key   5  When you are ready for production  complete the required approval and billing steps in the Dashboard and create a production key  6  Store the  clientId  and  consumerKey  on a secure backend   For plan limits and production requirements  see  Billing  https   docs snaptrade com docs billing     a id  getting started users    a        2  Register a SnapTrade User  A Commercial integration creates one SnapTrade  user  for each end user in the application   1  Call  api Authentication registerSnapTradeUser  with a stable  immutable  userId  from your system  Avoid using an email address  2  Store the returned  userSecret  securely  SnapTrade returns it only when the user is registered   The  userId  and  userSecret  identify this app user in subsequent user scoped requests        3  Connect a Brokerage  1  Call  api Authentication loginSnapTradeUser  using   Commercial API Key   authentication  2  Provide the app user s  userId  and  userSecret   3  If the user intends to trade  set  connectionType  to  trade if available   The default  read  connection type supports data access only  4  Open the returned Connection Portal URL and send the end user through the portal flow   After the user completes the flow  the connection and its brokerage accounts are available through SnapTrade   For more ways to open and configure the portal  see  Methods to Integrate the Connection Portal into Your Application  https   docs snaptrade com docs implement connection portal         4  Retrieve Accounts and Positions  1  Call  api AccountInformation listUserAccounts  with the user s  userId  and  userSecret   2  Choose the  accountId  for the account you want to inspect  3  Call  api AccountInformation getAllAccountPositions  with the  accountId    userId   and  userSecret    You can also retrieve balances with  api AccountInformation getUserAccountBalance  and orders with  api AccountInformation getUserAccountOrders         5  Place an Equity Trade  Commercial integrations can trade when trading is enabled for the API key  brokerage  connection  and account   1  Build the order using the account ID and the brokerage ticker in the  symbol  field  2  Validate the order details in your application and have the end user confirm them  3  Call  api Trading placeForceOrder  to submit the order to the brokerage   Include the user s  userId  and  userSecret  in each user scoped request   For order types  brokerage support  and other asset classes  see  Trading with SnapTrade  https   docs snaptrade com docs trading with snaptrade        Commercial Next Steps    Complete your OAuth integration with  Build an OAuth App  https   docs snaptrade com docs oauth apps     Configure  Webhooks  https   docs snaptrade com docs webhooks     Finish integrating the  Connection Portal  https   docs snaptrade com docs implement connection portal     Prepare your integration for production with  Launching Your Application  https   docs snaptrade com docs launching your application     Review Commercial pricing and limits in  Billing  https   docs snaptrade com docs billing     Back to customer models   getting started api keys        For troubleshooting  see the  FAQ  https   docs snaptrade com docs faq   If you still need help  contact us through  Discord  https   discord gg rkYWBxb8Qu   

Getting Started with SnapTrade

  Authentication Methods  SnapTrade supports two SDK authentication modes for API key integrations  Commercial API key and Personal API key  The selected SDK auth mode controls whether  userId  and  userSecret  are valid operation parameters   Commercial apps own many SnapTrade users  They register or authenticate a SnapTrade user  then fetch account data by passing that user s  userId  and  userSecret    Your Personal API key identifies your SnapTrade account directly  Account data is fetched without  userId  or  userSecret    In both modes  generate a Connection Portal URL and connect a brokerage account before calling account data APIs      Quick Comparison    Method   Best for   SDK auth setup   Account data operation credentials                               Commercial API key   Apps managing many end users    SnaptradeAuth commercialApiKey          SnapTradeAuth commercial api key         Pass  userId  and  userSecret      Personal API key   You  when calling SnapTrade with your own API key    SnaptradeAuth personalApiKey          SnapTradeAuth personal api key         Omit  userId  and  userSecret     For a broader product model comparison  see  SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial       Commercial API Key Authentication  Use Commercial API key authentication when your backend manages brokerage connections for your own end users   The Commercial workflow is   1  Initialize the SDK with Commercial  clientId  and  consumerKey   2  Register one SnapTrade user per end user with  api Authentication registerSnapTradeUser   3  Store the returned  userId  and  userSecret  for that SnapTrade user  4  Generate a Connection Portal URL with  api Authentication loginSnapTradeUser  and have the user connect a brokerage account  5  After the account is connected  fetch that user s account data by passing  userId  and  userSecret  to user scoped operations       TypeScript     typescript import   Snaptrade  SnaptradeAuth   from  snaptrade typescript sdk    const snaptrade   new Snaptrade        Commercial auth is for apps managing many SnapTrade users    auth  SnaptradeAuth commercialApiKey       clientId  process env SNAPTRADE CLIENT ID       consumerKey  process env SNAPTRADE CONSUMER KEY                 This user is one of your app s end users  const userId    snaptrade user 123    const registeredUser   await snaptrade authentication registerSnapTradeUser     userId       const userSecret   registeredUser data userSecret       Generate connection URL  const login   await snaptrade authentication loginSnapTradeUser     userId    userSecret       console log  Send this Connection Portal URL to your user    login data redirectURI       After the user connects an account  you can fetch their account data  const accounts   await snaptrade accountInformation listUserAccounts        Commercial account data calls include the user s credentials    userId    userSecret       const activities   await snaptrade accountInformation getAccountActivities     accountId  accounts data 0  id     userId    userSecret    startDate   2026 01 01     endDate   2026 01 31     limit  100       console log activities data            Python     python import os from snaptrade client import SnapTrade  SnapTradeAuth  snaptrade   SnapTrade        Commercial auth is for apps managing many SnapTrade users      auth SnapTradeAuth commercial api key          client id os environ  SNAPTRADE CLIENT ID            consumer key os environ  SNAPTRADE CONSUMER KEY               This user is one of your app s end users  user id    snaptrade user 123   registered user   snaptrade authentication register snap trade user      user id user id     user secret   registered user body  userSecret      Generate connection URL  login   snaptrade authentication login snap trade user      user id user id      user secret user secret     print  Send this Connection Portal URL to your user    login body  redirectURI       After the user connects an account  you can fetch their account data  accounts   snaptrade account information list user accounts        Commercial account data calls include the user s credentials      user id user id      user secret user secret     activities   snaptrade account information get account activities      account id accounts body 0   id        user id user id      user secret user secret      start date  2026 01 01       end date  2026 01 31       limit 100     print activities body       Rules     Use  SnaptradeAuth commercialApiKey  in TypeScript or  SnapTradeAuth commercial api key  in Python    Register or otherwise obtain a SnapTrade user s  userId  and  userSecret  before fetching that user s account data    Pass  userId  and  userSecret  on user scoped operations such as listing accounts  balances  positions  orders  holdings  activities  and connections    Keep the  consumerKey  and each user s  userSecret  on a secure backend  Do not expose them in browser or mobile clients      Personal API Key Authentication  Use Personal API key authentication when you call SnapTrade with your own Personal API key   Your Personal  clientId  and  consumerKey  identify your SnapTrade account  There is no separate SnapTrade end user record to register or pass on account data calls  Generate a Connection Portal URL  connect your brokerage account  then fetch account data directly       TypeScript     typescript import   Snaptrade  SnaptradeAuth   from  snaptrade typescript sdk    const snaptrade   new Snaptrade        Personal auth means your API key is the user context    auth  SnaptradeAuth personalApiKey       clientId  process env SNAPTRADE CLIENT ID       consumerKey  process env SNAPTRADE CONSUMER KEY                 Generate connection URL  const login   await snaptrade authentication loginSnapTradeUser     console log  Open this Connection Portal URL    login data redirectURI       After you connect your account  fetch data directly  const accounts   await snaptrade accountInformation listUserAccounts     const activities   await snaptrade accountInformation getAccountActivities        No userId or userSecret for Personal account data calls    accountId  accounts data 0  id     startDate   2026 01 01     endDate   2026 01 31     limit  100       console log activities data            Python     python import os from snaptrade client import SnapTrade  SnapTradeAuth  snaptrade   SnapTrade        Personal auth means your API key is the user context      auth SnapTradeAuth personal api key          client id os environ  SNAPTRADE CLIENT ID            consumer key os environ  SNAPTRADE CONSUMER KEY               Generate connection URL  login   snaptrade authentication login snap trade user    print  Open this Connection Portal URL    login body  redirectURI       After you connect your account  fetch data directly  accounts   snaptrade account information list user accounts    activities   snaptrade account information get account activities        No user id or user secret for Personal account data calls      account id accounts body 0   id        start date  2026 01 01       end date  2026 01 31       limit 100     print activities body       Rules     Use  SnaptradeAuth personalApiKey  in TypeScript or  SnapTradeAuth personal api key  in Python    Generate a Connection Portal URL and connect your brokerage account before fetching account data    Fetch account data directly after connection  Your Personal API key identifies your SnapTrade account    Omit  userId  and  userSecret  on account data operations    Do not call  api Authentication registerSnapTradeUser   User registration is for Commercial apps managing SnapTrade users for their own end users      Credential Rules  Commercial API key     SDK initialization uses Commercial  clientId  and  consumerKey  through the Commercial API key auth helper    User management operations register and authenticate individual SnapTrade users    User scoped account data calls include  userId  and  userSecret     Direct HTTP requests are signed with the Commercial  consumerKey    Personal API key     SDK initialization uses Personal  clientId  and  consumerKey  through the Personal API key auth helper    Your Personal API key identifies your SnapTrade account    Connection Portal login uses the Personal API key context and does not require  userId  or  userSecret     Account data calls omit  userId  and  userSecret     Direct HTTP requests are signed with the Personal  consumerKey       Direct HTTP Reference  Prefer the SDKs unless you need to debug a raw request   Commercial API key requests include  clientId    timestamp   a  Signature  header  and user credentials for user scoped endpoints      http   Commercial signed requests include the SnapTrade user s credentials  GET  api v1 accounts  account id  activities clientId  client id  timestamp  unix timestamp  userId  user id  userSecret  user secret  Signature   signature       Personal API key requests include  clientId    timestamp   and a  Signature  header  but omit user credentials      http   Personal signed requests omit user credentials  GET  api v1 accounts  account id  activities clientId  client id  timestamp  unix timestamp  Signature   signature       For signature details  see  Request Signatures  https   docs snaptrade com docs request signatures       Related     SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial     Getting Started with SnapTrade  https   docs snaptrade com docs getting started     Request Signatures  https   docs snaptrade com docs request signatures  

Authentication Methods

  SnapTrade Personal vs Commercial  SnapTrade supports two primary customer experiences    Personal   and   Commercial    Both can use SnapTrade to connect brokerage accounts  retrieve account data  and  where enabled  place trades  The important difference is who owns the SnapTrade account and how users are represented   Use this guide to choose the right integration model before building authentication  user registration  connection management  billing  and support flows      info Personal and Commercial are customer experiences  not billing plan names  Billing plans such as Build  Launch  and Custom control limits  pricing  and feature availability  A customer s Personal or Commercial experience controls how SnapTrade users  credentials  and Connection Portal flows behave          Quick Comparison    Area   Personal   Commercial                         Intended user   An individual using SnapTrade for their own brokerage accounts   A company building an app for its own end users     SnapTrade account owner   The individual investor   The developer  company  or partner     End user model   The signed in Personal user is the SnapTrade user   Your app creates one SnapTrade  userId  and  userSecret  per end user     Authentication options   OAuth for sharing connected account data  or a Personal client ID and consumer key for direct access   Commercial client ID and consumer key     API authorization   OAuth bearer tokens for apps  or signed requests with a Personal consumer key   Signed requests using the Commercial consumer key     User registration   Do not call  api Authentication registerSnapTradeUser  for Personal API key authentication   Call  api Authentication registerSnapTradeUser  before creating connections     Connection Portal   Opens for the Personal user s own brokerage connections   Opens for a specific SnapTrade user managed by your app     Trading   Supported for the Personal user s own accounts where enabled   Supported for app users where enabled     Webhooks   Available   Available     MCP server   Supported  the MCP server is designed for SnapTrade Personal users   Not used with Commercial developer API keys     Key lifecycle   Personal customers can create one Personal client ID and consumer key in the dashboard   Commercial customers start with a test key and can create production keys after KYC approval     Billing   Free   Connected users and usage under the Commercial customer agreement       Choose Personal When  Choose the Personal experience when the person using SnapTrade is connecting and managing their own brokerage accounts   Common Personal use cases include     An individual using the SnapTrade Dashboard directly    A CLI  desktop app  or AI assistant connector that lets the user sign in with their own SnapTrade account    Portfolio analysis and trading for the user s own accounts    Connection management for the user s own brokerages   Most Personal users connect their brokerage accounts in the SnapTrade Dashboard and authorize OAuth enabled apps or AI assistants to read their data  OAuth apps receive scoped tokens rather than the user s API credentials   Personal client ID and consumer key authentication is available for Personal users who need direct signed request workflows  including trading with their own accounts where enabled  The Personal user represents themselves  Unlike a Commercial integration  your app should not create a separate SnapTrade user for them   For Personal API key authentication     Sign requests with the Personal  consumerKey     Do not create a SnapTrade user with  api Authentication registerSnapTradeUser     Do not store or send a  userSecret     Omit  userId  and  userSecret  when making API requests  SnapTrade resolves the user from the Personal API key      Choose Commercial When  Choose the Commercial experience when you are building an application for your own end users and need SnapTrade as infrastructure behind your product   Common Commercial use cases include     A fintech app that lets many app users connect their brokerages    A portfolio management  tax  financial planning  trading  or analytics product    A backend service that needs to create  track  and support many SnapTrade users    Production integrations that need billing  compliance review  and higher limits   Commercial integrations use a SnapTrade client ID and consumer key  Your backend signs requests with the consumer key and keeps that key secret   For each end user in your application   1  Create a stable SnapTrade  userId  with  api Authentication registerSnapTradeUser   2  Store the returned  userSecret  securely  3  Generate a Connection Portal link with  api Authentication loginSnapTradeUser   4  Send your end user through the Connection Portal  5  Use the  userId    userSecret   and account IDs to retrieve data or perform enabled trading workflows   Commercial  userId  values should be immutable identifiers from your system  Avoid email addresses because users can change emails and because user IDs may appear in logs  support workflows  or billing reconciliation      Credentials And Keys  Both experiences can involve a SnapTrade client ID and consumer key  but they are used differently     Personal client ID and consumer key      Belong to an individual Personal customer    Represent that individual s SnapTrade access    Do not imply that your app should create subordinate SnapTrade users    Are useful for local tools or advanced Personal workflows where signed request authentication is available     Commercial client ID and consumer key      Belong to a company or developer customer    Represent an integration that manages many SnapTrade users    Must be stored only on a backend or other secure server side environment    Are used to generate request signatures and validate webhook signatures   In the SnapTrade Dashboard  Commercial customers typically create a test key first  Production key creation requires KYC approval and a payment method  Personal customers are limited to one free Personal client ID and consumer key for their own brokerage accounts      Users And Connections  The biggest implementation difference is whether your app creates SnapTrade users       Personal  With Personal API key authentication  the Personal API key identifies the SnapTrade user  Your app can call normal SnapTrade APIs  but user identity is inferred from the key  Do not call user registration endpoints or store a  userSecret    When opening the Connection Portal for a Personal API key user  generate the portal link without  userId  or  userSecret   SnapTrade resolves the Personal user s context from the API key       Commercial  With Commercial client ID and consumer key authentication  your app owns user mapping  Each end user of your app should have a corresponding SnapTrade user   A typical mapping is       Your app user      SnapTrade userId   userSecret      connections      accounts      Create one SnapTrade user per end user  then create one or more brokerage connections under that user  When a brokerage login contains multiple brokerage accounts  those accounts appear under the same connection      Trading And Write Access  Feature availability depends on the customer  key  brokerage  account  and plan   Personal users can trade with their own accounts using SnapTrade client ID and consumer key authentication where trading is enabled for the account and brokerage   For Commercial integrations  trading requires     A Commercial key with trading features enabled    A brokerage and account that support trading    A connection created with the appropriate connection type    Your application s own user confirmation and compliance flow before submitting orders   Both Personal and Commercial API keys can receive webhooks after a webhook listener URL is configured in the SnapTrade Dashboard      Billing And Limits  Personal versus Commercial determines the user model  Personal users are currently completely free  Commercial billing plans determine pricing  limits  and enabled features for Commercial customers   Commercial billing is usually based on connected users and usage under the customer s agreement  A connected user is an end user who has at least one completed brokerage connection or relevant sync activity during the billing period   Plan level settings can affect     Number of allowed connections    Whether data is real time or daily    Whether manual refreshes are enabled or billable    Access to recent orders  trading  and other paid features    Whether production keys can be created   For Commercial integrations  design your onboarding  usage tracking  and support workflows around the connected user model described in  Billing  https   docs snaptrade com docs billing   Personal users do not need to design around Commercial connected user billing      Implementation Checklist  Before building  decide     Is the person connecting accounts the SnapTrade customer  or is your company the SnapTrade customer    Will your backend sign API requests with a consumer key    Should your app call  api Authentication registerSnapTradeUser     Where will credentials and user secrets be stored    Who owns support for reconnecting brokerages and removing connections    If you are building a Commercial integration  which billing plan controls limits  data freshness  and feature access   If the user owns the SnapTrade account  use the Personal model  If your app owns the integration and manages many end users  use the Commercial model      Related     Getting Started with SnapTrade  https   docs snaptrade com docs getting started     Authentication Methods  https   docs snaptrade com docs authentication methods     Terminology  https   docs snaptrade com docs terminology     Billing  https   docs snaptrade com docs billing     Request Signatures  https   docs snaptrade com docs request signatures  

SnapTrade Personal vs Commercial

Build an OAuth App

Connection Portal

  Trading with SnapTrade  SnapTrade supports trading workflows for stocks  ETFs  other equities  options  and crypto  The exact feature set depends on the connected brokerage or exchange  so you should always  verify support  https   support snaptrade com brokerages  for the account you are about to trade with          Soft Rate Limit       We recommend limiting trade requests to   1 trade per second per account   to maximize execution success      Trading Overview  Most trading integrations with SnapTrade follow the same high level flow   1  Create or upgrade a trading enabled connection  2  Choose the brokerage account that will place the order  3  Build the order payload for the asset class you want to trade  4  Validate the order details in your application  5  Submit the order to the brokerage or exchange  6  Monitor execution status   The sections below explain how that flow differs for equities  options  and crypto      Confirm Order Details and Impact  Before submitting an order  show the account owner the order instructions  all available impact and fee information  the source of any estimates  and a clear confirmation action  A brokerage preview is not available for every supported trading workflow and is not a universal prerequisite for placing an order   See  Order impact and confirmation   docs order impact and confirmation  for confirmation requirements  recommended source labels and disclaimers  and guidance for orders without a reliable preview      Set Up Trading Access      Create a Trading Connection  By default  connections are created with read only permissions  To create a trading enabled connection  set the  connectionType  body parameter to  trade  when calling  api Authentication loginSnapTradeUser    If you want to request trading access when it is supported  but still allow the user to connect read only accounts elsewhere  use  connectionType trade if available  instead       Enable Trading for an Existing Connection  To enable trading for an existing read only connection  ask the user to re authorize access   1  Set the  reconnect  body parameter to the ID of the existing connection  2  Set  connectionType trade  when calling  api Authentication loginSnapTradeUser   3  Direct the user to the re authorization URL that SnapTrade returns      Stocks  ETFs  and Other Equities  Use the standard trading endpoints for single leg equity orders       Typical Equity Workflow  1  Identify the account that will place the order  2  Identify the instrument using its brokerage  symbol   This is the recommended identifier when placing orders  3  Build the order details        action    BUY  or  SELL        order type   for example  Market    Limit    Stop   or  StopLimit        time in force   for example  Day  or  GTC        units  for share quantity  or  notional value  when supported 4  Validate the order details in your application before submission  5  Submit the order with  api Trading placeForceOrder    For most use cases  it is better to validate the order in your own application and then place it directly with  api Trading placeForceOrder   If you need SnapTrade to simulate the order impact before submission  you can use  api Trading getOrderImpact  and then submit the returned  tradeId  with  api Trading placeOrder   but this is usually not the primary workflow we recommend       Extended Hours Equity Trading  Extended hours trading is brokerage specific and only available when both the account and the instrument support it   To request extended hours execution     Set  trading session  EXTENDED   in the order payload    Use a  LIMIT  order with an appropriate time in force    Expect brokerage specific restrictions  Many brokerages only allow  DAY  orders for extended hours trading  while some also allow  GTC       Options  SnapTrade supports both single leg option orders and multi leg option strategies  but support is narrower than it is for equities       Single Leg Option Orders  Single leg option orders use the same endpoint as multi leg option orders  but with a single leg   1  Build the order for  api Trading placeMlegOrder   providing only a single leg  2  Provide  instrument symbol  with an  OCC format  https   en wikipedia org wiki Option symbol OCC format   3  Use an option action such as  BUY TO OPEN    BUY TO CLOSE    SELL TO OPEN   or  SELL TO CLOSE   4  Set  units  to the number of option contracts  5  Validate the order details in your application and submit the order with  api Trading placeMlegOrder    This is the right workflow for straightforward option buys and sells where the order has only one leg       Multi Leg Option Strategies  For spreads  condors  and other multi leg strategies  use  api Trading placeMlegOrder    The multi leg payload lets you submit     an  order type    a  time in force    a  price effect  such as debit or credit   a  legs  array containing the option instruments  actions  and contract quantities  Because brokerages often report each leg separately  downstream order history can appear as multiple records for a single multi leg submission      Crypto  SnapTrade supports specialized crypto trading endpoints for some exchanges such as Kraken  Binance  and Coinbase   Crypto trading uses tradable asset pairs represented as  BASE QUOTE   The action determines the direction of the trade     On a  BUY   the base asset is what you are buying and the quote asset is what you are spending    On a  SELL   the base asset is what you are selling and the quote asset is what you are receiving       Typical Crypto Workflow  1  Use  api Trading searchCryptocurrencyPairInstruments  to find the tradable pairs for the connected account  2  If needed  filter by  base  or  quote  because exchanges can support different pairs and sometimes different tickers for the same asset  3  Use  api Trading getCryptocurrencyPairQuote  to retrieve a quote for the pair  Quote values are returned in units of the quote asset  4  Validate the order details in your application  5  Submit the order with  api Trading placeCryptoOrder    When placing a crypto order  set the  instrument symbol  to the trading pair and the  instrument type  to  CRYPTOCURRENCY PAIR   The  amount  is the quantity of the base asset to buy or sell   For most crypto integrations  validating the request in your own application is simpler than relying on the preview endpoint  If you need an exchange side preview   api Trading previewCryptoOrder  is available      json      account id      accountId        instrument          symbol    ETH EUR        type    CRYPTOCURRENCY PAIR          side    BUY      type    MARKET      amount    0 01      time in force    GTC      post only   false        In this example  the order buys  0 01  ETH with EUR      Brokerage Support and Reconciliation  Not every brokerage supports every trading workflow  Extended hours sessions  multi leg options  and crypto trading are all institution specific  Review the  SnapTrade Institution Support guide  https   support snaptrade com brokerages  before enabling a feature in production   After placing an order  we recommend you reconcile the latest state by pulling a list of recent orders with  api AccountInformation getUserAccountRecentOrders   

Trading with SnapTrade

  Order Impact and Confirmation  SnapTrade supports equity and option orders across institutions with different preview capabilities  A missing brokerage preview does not mean that an order cannot be placed  trading support and preview support are separate capabilities   In this guide   order  means either an equity order or an option order unless a section says otherwise  Always confirm the institution s current asset  order  and preview support in the  SnapTrade Institution Support guide  https   support snaptrade com brokerages       Confirm every order  Before submitting an order  present the available instructions and impact information clearly enough for the account owner to understand and consent to the order   The confirmation screen should include     Institution and brokerage account   Security symbol  option contract  or option legs  as applicable   Order action for the order or each option leg   Quantity in shares  units  notional amount  or contracts   Order type   Limit price  stop price  or net debit or credit  when applicable   Time in force   Available cash impact  commission  fee  and foreign exchange estimates   Source of the impact information  brokerage preview  application generated estimate  or not available   Clear disclosure describing unavailable values and the limits of any estimate   Explicit action through which the account owner confirms the order  SnapTrade s  Application Compliance Policy  https   snaptrade com compliance policy  requires applicable regulatory disclosures when an account owner issues trading instructions  If the execution price  fees  commissions  or cash impact are unknown or estimated  explain that clearly before the account owner confirms the order      Identify the impact source  The confirmation experience should distinguish the source of displayed values  Do not use the same label for brokerage supplied data  an application calculation  and unavailable information       Brokerage supplied preview  For supported equity orders   api Trading getOrderImpact  checks the order without placing it  For supported option orders   api Trading getOptionImpact  simulates an order with up to four legs  The response shape differs by workflow and institution   For option orders  available fields can include      estimated cash change   estimated cash change before fees    cash change direction   whether the order results in a debit  credit  even result  or unknown result    estimated fee total   estimated transaction fees and commissions  For equity orders  the preview can return estimated remaining cash  commission  and foreign exchange fees  The application can combine these values with the order details when presenting estimated totals  All preview values are estimates  not guaranteed execution amounts   Recommended source label       Impact source  Brokerage preview        Application generated estimate  When a brokerage does not expose a dedicated preview endpoint  an application can calculate a reasonable estimate from the latest available bid  ask  or last trade quote  the order quantity or notional amount  current cash balances  currency conversion assumptions  and any locally implemented commission or fee schedule   Recommended source label       Impact source  Application generated estimate     This application calculated these amounts using the latest available quote and fee assumptions  They were not supplied or verified by SnapTrade or the brokerage       No reliable estimate  If neither the brokerage nor the application can produce a reliable estimate  show the known order instructions and identify the missing values  Do not display unavailable fees or commissions as   0 00   zero can incorrectly suggest that no charges will apply   Recommended presentation       Estimated cash impact    Not available       Estimated fees and commissions    Not available     Recommended disclaimer language      Brokerage preview or application generated estimate      Estimated results    The amounts shown are estimates only and are not guaranteed  The brokerage determines the final execution price  transaction amount  commissions  fees  and cash impact  Market orders can fill at a different price than the latest quote  and orders may partially fill or fill over multiple days  Exchange  ECN  regulatory  ADR  foreign exchange  borrow  and other fees may apply  including when estimated commissions are   0 00    For an application generated estimate  place the application generated source label immediately before this disclaimer       Impact information unavailable      Order impact unavailable    A reliable pre trade impact or fee estimate is not available for this order  The final execution price  transaction amount  commissions  fees  and cash impact may not be known until the order is submitted or executed  Fees may apply  By submitting this order  you agree to proceed without these estimates      Does unavailable impact prevent trading   No  Preview support and trading support are separate institution capabilities  The  SnapTrade trading workflow   docs trading with snaptrade  requires applications to validate order details in their own interface  but it does not make a brokerage preview a universal prerequisite for every equity or option order   Before enabling a workflow  verify that the institution supports     Asset and symbol being traded   Requested order type and time in force   Fractional unit or notional orders  when applicable   Single leg or multi leg options  when applicable   Intended option action and number of legs  when applicable   Any institution specific permissions  account requirements  or limitations 

Order Impact and Confirmation

  Filtering Accounts by Category  SnapTrade connections can return multiple account types from a single brokerage login  For example  a Robinhood or Fidelity connection may include an investment brokerage account alongside a line of credit or deposit  bank  account   If your integration only supports investment flows   trading  holdings  balances   you ll want to filter out the non investment accounts so they don t surface in your UI or trade logic      The  kind  Field   api Connections listConnectionAccounts  returns the accounts for a connection in a  results  array  Each item in  results  is a discriminated union  every account includes a  kind  field that normalizes the account type across institutions and determines which other fields are present on the account     Value   Schema   Meaning                    investment     InvestmentAccount    Brokerage   investment account  equities  options  crypto        deposit     DepositAccount    Bank deposit account  checking  savings        line of credit     LineOfCreditAccount    Line of credit account  for example  loans or credit cards      Fields such as  id    connection id    display name    masked account number    sync status    raw type   and  net value  are shared across all kinds  Kind specific fields are only present on the matching schema   for example   funding date  and  is paper  are only returned for  investment  accounts  Note that  net value  is negative for  line of credit  accounts  representing money owed   New kinds may be added over time  Match on the kinds your integration supports and ignore any  kind  value you don t recognize  rather than assuming every non  deposit  account is an investment account   If a user has multiple connections  call  api Connections listBrokerageAuthorizations  first  then call  api Connections listConnectionAccounts  for each connection      The  raw type  Field  Alongside  kind   every account also includes a  raw type  field  This is the unnormalized account type string as provided by the institution  for example   Margin    INDIVIDUAL    ROTH    TFSA    Values differ per institution and are not standardized by SnapTrade   Use  raw type  when you need finer grained distinctions than  kind  provides   for example  separating retirement accounts from taxable brokerage accounts within the  investment  kind  For high level filtering between investment and non investment accounts  prefer  kind       Filtering in Your Code  The examples below list accounts across all of a user s connections and keep only the investment accounts  The SDK snippets show the Commercial API key shape with  userId  and  userSecret   Personal API key users should omit  userId  and  userSecret  for direct API calls  SDK support for Personal API key users is coming soon       Node js   TypeScript  In TypeScript  checking  kind  narrows the account to the matching schema  so kind specific fields are type safe after the check      ts import type   ConnectionAccount  InvestmentAccount   from  snaptrade typescript sdk    const   data  connections     await snaptrade connections listBrokerageAuthorizations     userId    userSecret       const accounts  ConnectionAccount         await Promise all      connections        filter  connection     connection id         map  connection             snaptrade connections listConnectionAccounts             connectionId  connection id             userId            userSecret                           flatMap  response     response data results    const investmentAccounts   accounts filter     account   account is ConnectionAccount   InvestmentAccount        account kind      investment         Or handle every kind explicitly  for  const account of accounts      switch  account kind        case  investment         console log account display name  account funding date  account is paper         break      case  deposit       case  line of credit         console log account display name  account net value         break      default           Unrecognized kind   skip it        break                 Python     python connections   snaptrade connections list brokerage authorizations      user id user id      user secret user secret    body  accounts      for connection in connections      accounts extend          snaptrade connections list connection accounts              connection id connection  id                user id user id              user secret user secret            body  results          investment accounts    a for a in accounts if a  kind       investment      Or handle every kind explicitly  for account in accounts      match account  kind            case  investment               print account  display name    account get  funding date    account  is paper            case  deposit     line of credit               print account  display name    account get  net value            case                  Unrecognized kind   skip it              pass          cURL     bash   Replace  connectionId  with an id returned by  authorizations    Commercial API key example  Personal API key requests omit userId and userSecret  curl  https   api snaptrade com api v1 connections  connectionId  accounts userId     userSecret            jq    results     select  kind     investment                See also     Account Data  https   docs snaptrade com docs account data     Trading with SnapTrade  https   docs snaptrade com docs trading with snaptrade  

Filtering Accounts by Category

  Real time vs Daily plans  SnapTrade offers two data freshness options for holdings data    Real time   and   Daily    These names describe how data is refreshed  they are separate from your billing model  You can confirm which option your API key uses on the  Customer Dashboard billing page  https   dashboard snaptrade com settings billing      Behavior   Real time   Daily                         Data returned   Supported holdings endpoints fetch the latest data from the brokerage when called    Holdings data is cached and refreshed once per day  Exact refresh timing may vary by brokerage      Intraday updates   Call the holdings endpoints again to fetch updated brokerage data    Call the  Refresh connection endpoint  https   docs snaptrade com reference Connections Connections refreshBrokerageAuthorization  to start an asynchronous update  Additional charges may apply      Completion signal   The API response contains the refreshed data    Wait for an  ACCOUNT HOLDINGS UPDATED webhook  https   docs snaptrade com docs webhooks webhooks account holdings updated  for each account before requesting the updated holdings     Holdings data includes positions  balances  orders  and account details  Data availability and freshness still depend on what each brokerage makes available      Recommended application flow      Real time  When a user logs in to your application  request the holdings data needed for their current view  Common endpoints include  List all account positions  https   docs snaptrade com reference Account 20Information AccountInformation getAllAccountPositions  and  List account balances  https   docs snaptrade com reference Account 20Information AccountInformation getUserAccountBalance    While the user remains active  request the data again as needed  To avoid SnapTrade and brokerage rate limits  we recommend polling no more often than once every 10 minutes per account       Daily  Use the cached daily data for normal application loads  If users need an intraday update  consider providing a refresh button that calls the  Refresh connection endpoint  https   docs snaptrade com reference Connections Connections refreshBrokerageAuthorization    A refresh runs asynchronously  After starting it  wait for an  ACCOUNT HOLDINGS UPDATED webhook  https   docs snaptrade com docs webhooks webhooks account holdings updated  for each account  then request the updated positions  balances  and other holdings data  Each refresh call may incur an additional charge according to your plan      Transactions  Transactions are cached  updated once per day  and delayed by one day on both Real time and Daily plans  If you need intraday trade activity  use orders instead  See  Syncing and Data Freshness  https   docs snaptrade com docs syncing  and  Orders compared with activities  https   docs snaptrade com docs account data account data orders  for details      Relevant endpoints     List all account positions  https   docs snaptrade com reference Account 20Information AccountInformation getAllAccountPositions     List account balances  https   docs snaptrade com reference Account 20Information AccountInformation getUserAccountBalance     List account orders  https   docs snaptrade com reference Account 20Information AccountInformation getUserAccountOrders     List recent account orders  https   docs snaptrade com reference Account 20Information AccountInformation getUserAccountRecentOrders     Get account details  https   docs snaptrade com reference Account 20Information AccountInformation getUserAccountDetails     Refresh a connection  https   docs snaptrade com reference Connections Connections refreshBrokerageAuthorization  

Real-time vs Daily plans

  Webhooks  The SnapTrade API can be configured to send you webhook notifications when certain events happen  API key integrations receive the API key webhook schema  while OAuth applications receive the versioned  oauth v1  schema described below   To get started with webhooks  visit the webhook tab of the SnapTrade Dashboard to configure a webhook listener     OAuth Application Webhooks  OAuth applications can receive connection and account events for SnapTrade Personal users  An event is delivered when all of the following are true     The OAuth app is registered under the SnapTrade customer that owns the configured webhook listener    The user has an active authorization for the app    The authorization includes the  webhook  scope   Request the scope alongside  read       text scope read webhook      Existing authorizations do not automatically gain a newly requested scope  A user who previously granted only  read  must go through the OAuth authorization flow again and approve  webhook  before the app can receive events for that user   OAuth apps registered under a customer reuse that customer s webhook URL  consumer key  and custom headers  If the customer has multiple OAuth apps  use  oauthClientId  in the payload to identify which app the notification targets  A Personal user who has granted webhook access to multiple apps can cause one notification to be delivered to each eligible app      OAuth Webhook Schema  OAuth application webhooks use  schemaVersion   oauth v1        json      schemaVersion    oauth v1      webhookId    35a74573 84a4 4cdd aa30 9719f89a0123      oauthClientId    portfolio app      eventTimestamp    2026 08 12T18 22 47 039837 00 00      userId    e474391b 01a0 4eaf 8b3b 3d9c546b790c      eventType    CONNECTION ATTEMPTED      brokerageId    a7f51999 ac26 4587 aa00 5dae607fd4a3      connectionId    7c382af7 1faa 490c 8d10 b15e27a36a14      connectionAttemptedResult    SUCCESS      details          sessionId    04525fa4 7194 4f37 ab15 c9eaa3bae886               Field   Description                    schemaVersion    The payload contract version  OAuth webhooks currently use  oauth v1        webhookId    The unique ID of this webhook notification       oauthClientId    The OAuth client ID of the application receiving the notification       eventTimestamp    When the event occurred  formatted as an ISO 8601 timestamp       userId    The SnapTrade Personal user UUID  This matches the  sub  claim of the  id token  returned during OAuth token exchange  and the deprecated  sub snaptrade user id  field       eventType    The event that occurred       connectionId    The brokerage connection UUID  when the event relates to a connection  This replaces  brokerageAuthorizationId  from the API key schema       brokerageId    The brokerage UUID  when available       accountId    The brokerage account UUID  when the event relates to an account       connectionAttemptedResult    The result of a connection attempt  when applicable       details    Additional event specific data  when available     The OAuth schema does not include the API key schema s  clientId    brokerageAuthorizationId   or  webhookSecret  fields  Continue to verify authenticity using the  Signature  request header     Verifying Webhook Authenticity    Note  Webhook secrets are deprecated   You can verify the authenticity of any SnapTrade webhook by using the  Signature  header contained in the webhook headers  and comparing that to the expected signature generated using your   consumer key    Note that the consumer key is different from the webhook secret that is being deprecated   The  Signature  header contains an HMAC SHA256 hash of the request body  using your consumer key as the key   Here s an example implementation of a Flask webhook handler that verifies the authenticity of incoming webhooks      python from base64 import b64encode from hashlib import sha256 import datetime import hmac import json import os from flask import Flask  request  jsonify  app   Flask   name     CONSUMER KEY   os getenv  SNAPTRADE CONSUMER KEY     app route      methods   POST    def webhook listener          Extract the payload     payload   request get json          Extract the Signature header     signature   request headers get  Signature          Verify the signature     sig content   json dumps payload  separators             sort keys True      sig digest   hmac new CONSUMER KEY encode    sig content encode    sha256  digest       calculated signature   b64encode sig digest  decode        if calculated signature    signature          raise Exception  Signature verification failed               Prevent replay attacks by checking the timestamp and making sure it was sent recently     timestamp   datetime datetime fromisoformat payload  eventTimestamp        if  datetime datetime now datetime timezone utc    timestamp  total seconds     300          raise Exception  Payload is too old         print  Signature verified successfully           Log the received data     print  Received payload    payload         Respond with a success message     return jsonify      200  if   name         main         app run host  0 0 0 0   port 5123       Aside from signature verification     SnapTrade supports custom webhook request headers  which are useful if your webhook handler is protected by Cloudflare    SnapTrade does not support IP whitelisting at this time    Handling Undeliverable Webhooks  When your webhook handler responds to our requests with a status code that is not 200  201  202  or 204  we mark that webhook as undelivered in our system   We will attempt to resend an undeliverable webhook notification with an exponential backoff  starting at 30 minutes  until it is either delivered successfully  or 3 retry attempts have been made     Webhook Types  The different webhook event types are outlined below      USER REGISTERED  Sent when a new user is successfully registered through the   registerUser   endpoint   Example payload is below      json      webhookId    dbaee13a 1184 4677 9741 b6845e60ee3a      clientId    phjBdpKfpN      eventTimestamp    2022 05 31T11 16 54 658533 00 00      userId    qQYISR9xcmR8ZtVHNgg1lbYgSQcxafPqPW0ZbE0yaA6ham6n54      eventType    USER REGISTERED      webhookSecret    lgCQWztweEFcHvjdLhHc            USER DELETED  Sent when a user is successfully deleted through the   deleteUser   endpoint   Example payload is below      json       userId   TOD1ACWHxnO9cnpq9XgNmFaRwXRMRu2taaFPpvYi6ng3uD2UN9       clientId   phjBdpKfpN       eventType   USER DELETED       webhookId   dbaee13a 1184 4677 9741 b6845e60ee3a       webhookSecret   lgCQWztweEFcHvjdLhHc       eventTimestamp   2025 01 08T14 32 59 979214 00 00            CONNECTION ATTEMPTED  Sent when a user a user attempts to make a brokerage connection  will also report the result of the attempt   Example payload is below      json      webhookId    6594d898 7377 453b 989e 03545ebde8bf      clientId    kqLsLciREm      eventTimestamp    2022 05 31T11 17 17 804976 00 00      userId    TOD1ACWHxnO9cnpq9XgNmFaRwXRMRu2taaFPpvYi6ng3uD2UN9      eventType    CONNECTION ATTEMPTED      connectionAttemptedResult    SUCCESS      brokerageId    c8153291 0761 43a8 8ed0 4642103c2cb8      webhookSecret    PajFGRsWwxgckkOZwteW         Possible values for the  connectionAttemptedResult  field are      SUCCESS     AUTH EXPIRED     INVALID AUTH CODE     AUTH NOT IN PROGRESS     DIFFERENT ACCOUNT     UNCAUGHT ERROR     INVALID CREDENTIALS     INVALID MFA CODE     NO DATA      CONNECTION ADDED  Sent when a new brokerage connection is created using the SnapTrade connection portal   Example payload is below      json      webhookId    7467e5e4 4b59 4514 9d04 d05dbc10dea9      clientId    cJEQQgtDIb      eventTimestamp    2022 05 31T11 13 37 269120 00 00      userId    oWbLZ3OWsO3Nt8DKJnYxM32wLLD6h6SVj0ywkDmypUlkWkqsI5      eventType    CONNECTION ADDED      brokerageId    c8153291 0761 43a8 8ed0 4642103c2cb8      brokerageAuthorizationId    a0231bd2 9b77 4732 ba78 f9c6af6a1a62      webhookSecret    ZSDkaLCRJndeZGgeaJnV            CONNECTION DELETED  Sent when a user deletes an existing connection   Example payload is below      json      webhookId    85a63984 6fb6 45fb bc3b 18582a89ab3c      clientId    gxKWQEIXGS      eventTimestamp    2022 05 31T11 35 33 753881 00 00      userId    a053epCMsmII9goant5wdQH7CaT0M00HgQiRaxWnK0MncDUF2c      eventType    CONNECTION DELETED      brokerageId    c8153291 0761 43a8 8ed0 4642103c2cb8      brokerageAuthorizationId    a0231bd2 9b77 4732 ba78 f9c6af6a1a62      webhookSecret    lbTycRhXwzVRJPovdNSN            CONNECTION BROKEN  Sent when a user s connection is broken  also referred to as disabled  for some reason  usually an inability to handshake with the brokerage s API  To resolve this state  see  Fix Disabled Connections  https   docs snaptrade com docs fix broken connections    Example payload is below      json      webhookId    434d23af 5f89 44f8 9415 5029557e64c7      clientId    yLNANjmwau      eventTimestamp    2022 05 31T11 37 50 590720 00 00      userId    DbjLqtPsj6G1MlDLtZaps4YhtckD0jWOuLQjl6GPW4FmpUa8eo      eventType    CONNECTION BROKEN      webhookSecret    SCNsZYmJcuXRiznplDdL      brokerageAuthorizationId    dc90a844 367b 4120 8b56 21040bfa6525            CONNECTION FIXED  Sent when a broken  disabled  connection is fixed   Example payload is below      json      webhookId    ae73c055 2308 4de4 bf0e d828bbac8c91      clientId    BVmifPEScc      eventTimestamp    2022 05 31T11 52 26 803063 00 00      userId    EKDO7W7YSWEZkOZUN5v1iMGF7ipEmOGjc6bMEm89y6vCrtnebH      eventType    CONNECTION FIXED      webhookSecret    zNKlROkqSEXjXBxfTsAu      brokerageAuthorizationId    5e942e13 2b39 47b2 b524 858b9d9849ed            CONNECTION UPDATED  Sent when a brokerage connection is updated   Example payload is below      json      webhookId    57a293e4 f7eb 49ad 92e2 80ac16e01af7      clientId    IZtBuuKXEA      eventTimestamp    2022 05 31T11 53 09 437310 00 00      userId    sXQQcRdQEmGSMizpv45gBlBANBeCWgEn9uSmLlEpa1YsZ7oAW8      eventType    CONNECTION UPDATED      webhookSecret    oHdlCBoExKtosDtTLVDc      brokerageAuthorizationId    7ed55083 7128 46ff 9317 43cd788f43ff            CONNECTION FAILED  Sent when a user s attempt to connect to a brokerage has failed   Example payload is below      json      webhookId    57a293e4 f7eb 49ad 92e2 80ac16e01af7      clientId    IZtBuuKXEA      eventTimestamp    2022 05 31T11 53 09 437310 00 00      userId    sXQQcRdQEmGSMizpv45gBlBANBeCWgEn9uSmLlEpa1YsZ7oAW8      eventType    CONNECTION FAILED      webhookSecret    oHdlCBoExKtosDtTLVDc            NEW ACCOUNT AVAILABLE  Sent when a new account is detected through a brokerage connection   Example payload is below      json      webhookId    6fe03e8c 201a 4c3f 92d0 acb825fc89cf      clientId    SjWLDemQUF      eventTimestamp    2022 05 31T12 37 18 630476 00 00      userId    hmznAjmLezKPaSnLIiNQweSGsf7MIlEvm9dcTao3gwjgBtulLK      eventType    NEW ACCOUNT AVAILABLE      webhookSecret    HZRnYEhLPgwyUXitkJBd      accountId    ec20134b 72e7 4e72 9b4c 9c7ddd1c479c      brokerageAuthorizationId    795de4e6 260e 45b3 815b 8f601c4cf448            ACCOUNT TRANSACTIONS INITIAL UPDATE  Sent when we complete the initial transactions sync after a new account is connected  The duration needed for the first sync can vary by brokerage and by how many historical transactions the user has  but usually takes between 1 60 seconds   Example payload is below      json      webhookId    aa7a7d5a 4a12 40df a329 feedc738eee9      clientId    rmCZBUGAXP      eventTimestamp    2022 05 31T12 39 47 182403 00 00      userId    7jN22b2AWHMOqOeujjaiU5kKOM8iITt11ENcUMftx6LBg9GTn2      eventType    ACCOUNT TRANSACTIONS INITIAL UPDATE      webhookSecret    gQNuZIBwPYUVAsXvCfOA      accountId    d9f55a48 5dc6 4100 acee 24e5dfd8ec26      brokerageAuthorizationId    d28affae f918 4ecd 8128 e5438e861706            ACCOUNT TRANSACTIONS UPDATED  Sent when account transactions are incrementally updated  After the initial sync has already completed  account will be checked for new transactions daily  If new transactions are found they will be saved and this webhook will be sent  Only ACCOUNT TRANSACTIONS INITIAL UPDATE gets sent upon first connection   Example payload is below      json      webhookId    4eb13e1c 5778 44c2 968d 813d81cb73a1      clientId    JELZRJPqui      eventTimestamp    2022 05 31T12 40 05 944481 00 00      userId    4XTxw0mZhffRCdrgPHBG1VqdklkVJdEz5Uor0hq29hwPYlLS7s      eventType    ACCOUNT TRANSACTIONS UPDATED      webhookSecret    DDAVBuPPGgqwADXgbcOE      accountId    6e30be12 4ab0 4ec0 8d4d 0dfdce509e36      brokerageAuthorizationId    8105b33e 3dd6 4189 b93e 31ccaa9d3b69            ACCOUNT REMOVED  Sent when an account is removed from a connection   Example payload is below      json      webhookId    60b9ad5f 9e78 43b2 af5a 8ce8412b1cd6      clientId    PARTNERAPP      eventTimestamp    2024 05 31T12 40 05 944481 00 00      userId    4XTxw0mZhffRCdrgPHBG1VqdklkVJdEz5Uor0hq29hwPYlLS7s      eventType    ACCOUNT REMOVED      webhookSecret    DDAVBuPPGgqwADXgbcOE      accountId    6e30be12 4ab0 4ec0 8d4d 0dfdce509e36      brokerageAuthorizationId    8105b33e 3dd6 4189 b93e 31ccaa9d3b69            ACCOUNT HOLDINGS UPDATED  Gets sent when holdings for an account has been updated  Updated does not necessarily mean that the holdings have changed  instead it means that updating holdings with new data has been attempted  In the rare case that a holdings update fails  for example when a brokerage s API is down for maintenance   the webhook will still be sent and details on what failed will be included as part of the details field in the body   This webhook will be sent when we run our daily account syncs  as well as if a manual account refresh has been requested via  https   docs snaptrade com reference Connections Connections refreshBrokerageAuthorization  Account Holdings in this context refers to     Positions    Balances    Orders    Total Account Value    Account Detail  Historical transactions will be polled for  but will not fetch transactions from the current day  Example payload is below     json      userId    60b9ad5f 8e78 43b2 af5a 8ce8412b1cd6      clientId    PARTNERAPP      accountId    45a3g56a eef6 4904 a68e d3f90c3e07c5      eventType    ACCOUNT HOLDINGS UPDATED      webhookId    312a13f3 3929 46dd a70f ade6aaefc100      brokerageId    905872ac a7b1 4031 a31f 790cba1bfc94      webhookSecret    yfqvPlWrTFILBcjCERPh      eventTimestamp    2024 03 01T14 38 13 111991 00 00      brokerageAuthorizationId    6bb1ahb0 b8c8 4b59 8bf9 7841d7a89c63      details          total value      success   true   error   null         positions      success   true   error   null         balances      success   true   error   null         orders      success   true   error   null                 TRADE DETECTION  Gets sent seconds after a trade has been executed in a specific account  Requires an account specific subscription  Please contact support snaptrade com  or reach out on discord slack  for more information about pricing and setting up subscriptions  Only available on certain brokerages   Returns a list of orders placed  Example payload is below     json        userId    60b9ad5f 8e78 43b2 af5a 8ce8412b1cd6        details              orders                                    legs                                                    action    BUY TO OPEN                            leg id   null                           status    EXECUTED                            instrument                                  symbol    AAPL  261218C00240000                                figi code   null                               asset type    OPTION                                description    AAPL CALL 7 17 240                                exchange mic code    OPRA                                                      total quantity    1 000000000                            execution price    19 2000000000                            filled quantity    1 000000000                            canceled quantity   null                                                           status    EXECUTED                    order role   null                   order type    LIMIT                    stop price    0 0000000000                    limit price    19 2000000000                    time placed    2026 05 08T18 52 02 810000Z                    time executed    2026 05 08T18 52 02 848000Z                    time in force    DAY                    trailing stop   null                   price currency    USD                    execution price    19 2000000000                    brokerage order id    124912433123                    brokerage group order id   null                                   detection lag seconds   5 276             clientId    PARTNERAPP        webookId    6963bc1c 8bca 4896 8faa e84b82f8f7b2        accountId    ad4202bb eaf7 4c7c a176 e8406612b1ca        eventType    TRADE DETECTION        webhookId    763bc1cd 8aca 4896 8faa e84b82f8f7b2        brokerageId    02952334 1d52 436f ba74 f3e9a98ea635        webhookSecret    yfqvPlWrTFILBcjCERPh        eventTimestamp    2026 05 08T18 52 08 123974 00 00        brokerageAuthorizationId    6bb1ahb1 b8c8 4b59 8bf9 7841d7a89c63            TRADE UPDATE  Beta webhook that gets sent when the status of trade placed through SnapTrade changes  For example  will be sent if a trade gets cancelled  executed  partitally filled  etc  Please contact support snaptrade com  or reach out on discord slack  to try out this experimental webhook  Only trades placed through SnapTrade will be monitored for status updates   Returns a the current order detail in the webhook body  Example payload is below     json        userId    60b9ad5f 8e78 43b2 af5a 8ce8412b1cd6        details              orders                                    legs                                                    action    BUY TO OPEN                            leg id   null                           status    EXECUTED                            instrument                                  symbol    AAPL  261218C00240000                                figi code   null                               asset type    OPTION                                description    AAPL CALL 7 17 240                                exchange mic code    OPRA                                                      total quantity    1 000000000                            execution price    19 2000000000                            filled quantity    1 000000000                            canceled quantity   null                                                           status    EXECUTED                    order role   null                   order type    LIMIT                    stop price    0 0000000000                    limit price    19 2000000000                    time placed    2026 05 08T18 52 02 810000Z                    time executed    2026 05 08T18 52 02 848000Z                    time in force    DAY                    trailing stop   null                   price currency    USD                    execution price    19 2000000000                    brokerage order id    124912433123                    brokerage group order id   null                                     clientId    PARTNERAPP        webookId    6963bc1c 8bca 4896 8faa e84b82f8f7b2        accountId    ad4202bb eaf7 4c7c a176 e8406612b1ca        eventType    TRADE UPDATE        webhookId    763bc1cd 8aca 4896 8faa e84b82f8f7b2        brokerageId    02952334 1d52 436f ba74 f3e9a98ea635        webhookSecret    yfqvPlWrTFILBcjCERPh        eventTimestamp    2026 05 08T18 52 08 123974 00 00        brokerageAuthorizationId    6bb1ahb1 b8c8 4b59 8bf9 7841d7a89c63        

Webhooks

  Rate Limiting  The SnapTrade API uses rate limiting to protect against bursts of incoming traffic and help maximize stability  Sending too many requests in quick succession will trigger error responses with HTTP status code  429    There are two layers of rate limiting that may apply to your requests   1    Customer level rate limiting      a global limit across all requests from your  clientId   2    Account level rate limiting      a  per account  https   docs snaptrade com docs account data  limit on specific account data endpoints  This layer applies only to  SnapTrade Personal  https   docs snaptrade com docs personal vs commercial  users  Commercial users are subject to the customer level limit only   A request must pass every layer that applies to you  For Personal users  even if you have remaining capacity at the customer level  you can still be throttled at the account level  and vice versa   When you exceed a rate limit  the API returns an HTTP status code  429  with a response body indicating how long to wait before retrying      json   detail   Request was throttled  Expected available in 7 seconds    status code  429  code   0000           Customer Level Rate Limiting  Every SnapTrade client is rate limited to   250 requests per minute   by default  This limit applies globally across all API endpoints and all accounts  If you need a higher limit  paid customers can  SnapTrade support  mailto support snaptrade com  to request a limit increase       Response Headers  The following headers are returned on every response to help you track your customer level usage     Header   Description                X RateLimit Limit    The maximum number of requests you can make per minute       X RateLimit Remaining    The number of requests remaining in the current rolling window       X RateLimit Reset    The number of seconds until the next minutely rate limit resets     These are rolling limits that look at the trailing 60 seconds      Account Level Rate Limiting  In addition to the customer level limit  the SnapTrade API enforces a   per account   rate limit on endpoints that fetch account data  This limit is   10 requests per minute per account   by default       Note    As noted above  account level rate limiting is only enforced for   Personal   users  Commercial users are subject to the customer level limit only  For more on the difference  see  SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial    Account level rate limiting is scoped to the combination of your  clientId  and the  accountId  in the request URL  This means     Different accounts have   separate   rate limit buckets  Exhausting the limit on one account does not affect requests to other accounts    Different endpoints for the   same account share   a single bucket  For example  fetching balances and positions for the same account both count toward that account s limit       Affected Endpoints  Account level rate limiting applies to the following endpoints      api AccountInformation getUserHoldings     api AccountInformation getUserAccountDetails     api AccountInformation getUserAccountBalance     api AccountInformation getAllAccountPositions     api AccountInformation getUserAccountOrders     api AccountInformation getUserAccountRecentOrders     api AccountInformation getAccountActivities     api AccountInformation getUserAccountOrderDetail     api Trading getUserAccountQuotes       Note    While the per account rate limit allows up to 10 requests per minute  these endpoints should not be polled at this frequency  See  API Polling Patterns  https   docs snaptrade com docs launching your application 3 api polling patterns  for recommended usage patterns       Response Headers  When account level rate limiting is active  the following additional headers are returned     Header   Description                X RateLimit Account Limit    The maximum number of requests allowed per minute for this account       X RateLimit Account Remaining    The number of requests remaining for this account in the current rolling window       X RateLimit Account Reset    The number of seconds until the next request slot opens up for this account  This value counts down as time passes  reflecting the actual time until the oldest request in the window expires     These are rolling limits that look at the trailing 60 seconds      How the Two Layers Interact  Every request to an account endpoint is checked against both rate limits  The stricter limit wins     Customer Level   Account Level   Result                   Remaining capacity   Remaining capacity     Allowed       Remaining capacity   Exhausted     429    account limit      Exhausted   Remaining capacity     429    customer limit      Exhausted   Exhausted     429    both limits     When you receive a  429   check both sets of response headers to determine which limit you hit  If  X RateLimit Remaining  is  0   you have hit the customer level limit  If  X RateLimit Account Remaining  is  0   you have hit the account level limit      Common Causes and Mitigations      Aggressive syncs    Syncing user portfolios all at once increases the chance of hitting both rate limit tiers  Space out data syncs over time  and rotate across accounts rather than polling a single account repeatedly      Polling a single account    Rapidly polling the same account for updates  e g   order status  will quickly exhaust the per account limit  Use webhooks where available  or poll at intervals of at least 15 seconds per account      Increased user signup volumes    A sudden influx of new users  e g   after announcing a new integration  can spike customer level usage  Space out onboarding requests over a period of time      Best Practices for Handling 429s  You should add logic to your integration to watch for  429  responses from the API and handle them with a retry mechanism       Check the  Reset  header    Use  X RateLimit Reset   customer level  or  X RateLimit Account Reset   account level   depending on which limit you hit  to determine exactly how long to wait before retrying      Use exponential backoff    If headers are unavailable or you prefer a general approach  retry with exponential backoff      Add jitter    Introduce randomness into your retry timing to prevent  thundering herd problems  https   en wikipedia org wiki Thundering herd problem       Spread requests across accounts    If you need to sync multiple accounts  round robin across them rather than exhausting one account s limit before moving to the next  

Rate Limiting

  Launching your Application  Before you launch to production with the SnapTrade API  you should conduct a pre production implementation review  This ensures you ll have a successful launch and provide a great end user experience   The goal of this review is to     Enhance both your experience as a SnapTrade user and your end users  app experience   Prevent and minimize common pitfalls   Understand and optimize your needs and use cases  while identifying potential product gaps   Ensure a smooth product launch     The Pre Launch Checklist      1  SnapTrade Compliance Policy  You have read the  SnapTrade Compliance Policy  https   snaptrade com compliance policy  and your application is in compliance       2  API polling patterns  You shouldn t call the Balances  Positions and Orders endpoint more than 4 times per day per user in the background  or more frequently than once per end user login and at set intervals while the user is actively using your app   You don t call the activities  transactions  endpoint more than once per account every 24 hours for an account   If you run a daily job to pull data  you spread the calls out as much as possible over the period   If your app uses webhooks  you poll the API correctly  using the proper endpoint and payload data  in response to the specific webhook type received       3  User Onboarding  For Commercial API key integrations  you should have a user onboarding flow that handles registering a SnapTrade user and storing the generated user secret  Personal API key integrations should not register users or store  userSecret  values   SnapTrade allows read only access or trading access for brokerage connections  Making the user explicitly decide as part of the authentication flow helps them understand the nature of the connection they re creating  and ensures a good user experience       4  Users can View and Delete their Connections  The ability to view and delete existing connections is critical to allow users to manage their authorizations  and to stay compliant with GDPR and privacy guidelines   The following endpoints have the information you need for this      api Connections listBrokerageAuthorizations     api Connections removeBrokerageAuthorization       5  Handle Disabled Connections  You have a system for detecting disabled end user brokerage connections  via webhook  and a defined re connection flow to fix broken connections  This includes at least one method of detection and one way to notify users  such as in app notifications or emails    See  How to Fix Broken Connections  https   docs snaptrade com docs fix broken connections       6  New Integrations  You have a strategy for handling newly released integrations  If you are making use of the  broker  parameter when calling  api Authentication loginSnapTradeUser   you will need to manually add any new brokerage integrations that are released  If you are not using this parameter  newly released integrations will appear automatically in the Connection Portal  You can call  api ReferenceData getPartnerInfo  to stay up to date  This returns the configuration for your Clint ID  including allowed brokerage integrations and data access       7  Rate limiting  You are aware of the general rate limit and have a way of gracefully handling rate limit 429 errors in your app  If you re using trading functionality  you re not executing trades faster than 1 trade per connected account per second   See  Ratelimiting  https   docs snaptrade com docs ratelimiting        8  Trading  If you re using trading functionality  you must have either clear user consent for automated trading or an order confirmation flow that shows all available impact  fee  and commission information  Clearly identify estimates and unavailable values  and obtain the account owner s consent before proceeding without exact information  Users must also have the ability to opt out of SnapTrade functionality and delete their brokerage connection at any time  It s recommended to not execute trades faster than 1 trade per connected account per second   See  Trading with SnapTrade   docs trading with snaptrade  and  Order impact and confirmation   docs order impact and confirmation        9  Webhooks  You have set your webhook listener URL in the  SnapTrade Dashboard  https   dashboard snaptrade com       Next Steps    Get your Production Keys through the  SnapTrade Dashboard  https   dashboard snaptrade com    Reach out to us at  support snaptrade com  mailto support snaptrade com  or over  Discord  https   discord gg UDwzZUuQ  

Launching your Application

  Trade Detection Subscriptions      Summary    Important behavior and integration details for SnapTrade  TRADE DETECTION  webhook subscriptions      Related docs     Real time vs Daily plans    realtime data    TRADE DETECTION webhook    webhooks webhooks trade detection    TRADE DETECTION  notifies partners when SnapTrade detects an executed order in a subscribed account  This feature is only supported for accounts where the brokerage supports realtime order updates  You can manage your subscriptions when logged in to the SnapTrade Dashboard at https   dashboard snaptrade com webhooks     Eligibility  Trade detection runs only when all of the following are true     The account has an active  TRADE DETECTION  subscription for a supported brokerage    The customer has a paid SnapTrade key and is in good standing in terms of billing    The underlying brokerage connection is enabled and can return realtime order data   Because disabled or broken connections cannot return new data  partners should also listen for  CONNECTION BROKEN  webhooks  When a connection breaks  prompt the user to fix it as soon as possible using the public reconnection guidance   Fix Broken Connections  https   docs snaptrade com docs fix broken connections       Supported Brokerages  The following brokerages support  TRADE DETECTION  at every available detection frequency     Webull   tastytrade   Alpaca   Moomoo   Webull Canada  The following brokerages support  TRADE DETECTION  only at intervals of five minutes or longer     Schwab   Robinhood   Wealthsimple   E Trade   Questrade  Brokerage availability can change as brokerage capabilities change  Do not assume every brokerage supports  TRADE DETECTION   and feel free to ask about specific brokerage support      Scheduling  Trade detection is currently scheduled only near regular market hours  weekdays from about  9 00 AM  to  4 30 PM America New York    This is the current scheduler behavior  not a contractual delivery SLA  Orders outside this window may not produce immediate  TRADE DETECTION  notifications      How To Interpret The Webhook  Use the order payload  not webhook delivery metadata  to determine when a trade executed      details orders    contains the detected order records     details orders   time executed  is the source of truth for when the order was executed     eventTimestamp  is when SnapTrade created the webhook event     details detection lag seconds  is the delay from execution to webhook delivery in seconds   For order execution timing  prefer  details orders   time executed  over  eventTimestamp  Brokerages usually make orders available over their API only a few seconds after execution  but can occasionally have a longer delay of a minute or two  SnapTrade has no control over these intermittent brokerage delays  If your handling is time sensitive  use  details detection lag seconds  to check how stale a fill is before acting on it   Connection health is a separate signal  A  TRADE DETECTION  subscription on an account does not mean the connection is currently healthy  so partners should use connection webhooks such as  CONNECTION BROKEN  and  CONNECTION FIXED  to keep users  brokerage connections usable      Billing  Trade detection billing is seat based  One seat is one subscribed account for one month   For example  if a partner subscribes three accounts for trade detection in a billing month  that counts as three seats for that month   The monthly cost for each subscribed account depends on the selected detection frequency     Detection frequency   Cost per account per month                    5 seconds    100 00     25 seconds    25 00     100 seconds    7 50     300 seconds  5 minutes     2 50     900 seconds  15 minutes     0 83     1500 seconds  25 minutes     0 50    For Schwab  Robinhood  Wealthsimple  and E Trade  select the 300   900   or 1500 second plan  faster frequencies are not supported  

Trade Detection Subscriptions

  Tax Lots      Summary    Tax lots is a feature available on certain brokerages that provides the acquisition and cost basis details for the individual lots that make up a position  The data comes directly from the brokerage and is not created by SnapTrade   A tax lot represents a specific acquisition of a security  When a position was built through multiple purchases  its tax lots can provide the purchase date  quantity  purchase price  cost basis  current value  and position type for each acquisition   When enabled  tax lots are returned in the  tax lots  field of supported stock  ETF  and mutual fund positions from the  List all account positions  https   docs snaptrade com reference Account 20Information AccountInformation getAllAccountPositions  endpoint  Tax lot data is not available for every brokerage  account or position  Positions that do not have tax lot data will return an empty list      Brokerage support  To confirm support for a brokerage  see the  supported brokerages page  https   support snaptrade com brokerages   Look under   Positions   recent orders   for the   Tax Lots available   capability   Brokerage capabilities may change  so check this page before relying on tax lot data in your application      Enabling tax lots  Tax lots are an optional paid feature and are disabled by default  You can enable them for an additional cost from the  SnapTrade Dashboard add ons page  https   dashboard snaptrade com add ons    After enabling the feature  request the account s positions as usual and read the  tax lots  array when it is present  Your integration should handle positions without tax lots  since the underlying brokerage may not support the feature or may not return lot level data for a particular position      Billing behavior  Tax Lots is billed as an add on to your standard connected user charges  Only distinct users who had at least one qualifying connection through a tax lot supported brokerage during the invoice period are included in the add on charge   If the feature is enabled mid month  Tax Lot charges are prorated by the number of calendar days the feature is active in the billing period    unit price   eligible users    active days   days in billing period    Eligible users are distinct users who had at least one qualifying event through a supported brokerage at any point in the invoice period  This count is prorated from the activation date   A normal customer cancellation is scheduled for the first day of the following month  Tax Lots remains active through the end of the current month  so the cancellation does not reduce that month s charge   Your invoice will have an item detailing the tax lot charge and the number of eligible users based on if they had at least one connection that supports the tax lot feature during the month  

Tax Lots

  OpenBB Snaptrade App  The OpenBB Snaptrade app connects your own brokerage accounts to OpenBB Workspace through  SnapTrade  https   snaptrade com   so you can see your live holdings  balances  orders  and activity next to the rest of your research   plus let the Workspace AI agent answer questions about your real portfolio           1  Create a SnapTrade account  Sign up for a personal SnapTrade account at   https   dashboard snaptrade com signup personal              2  Get your API keys  Go to   https   dashboard snaptrade com api key    Your key pair is already there       Client ID       Consumer key    Copy both   you ll paste them into Workspace in the next step   Treat these keys like a password  they unlock the brokerage accounts you connect  Don t share them  and don t put them into a Workspace instance other people can use           3  Add your credentials in OpenBB Workspace  The OpenBB Snaptrade app is available in the OpenBB Workspace app marketplace   Click   Add Authentication   and add these two headers  using the values from step 2     Header name                         Value                                                                            x openbb snaptrade client id       Your client ID         x openbb snaptrade consumer key    Your consumer key            4  Connect a brokerage account  Connections are   read only     1  Open the   SnapTrade   app     Connections   tab   Or add the   Manage Connections   widget to any dashboard of your own   2  Click   Get Started    SnapTrade s Connection Portal opens inside the widget  3  Pick your brokerage from the list and sign in   on your brokerage s own page    4  When the portal finishes  you re returned to the connections list with the new connection showing  Your accounts now populate every widget   The same widget is where you manage connections afterward       Connect an Account     link another brokerage      Disconnect Account     remove a connection  its accounts drop out of the dashboards immediately      Reconnect     re authorize a connection your brokerage has expired  

OpenBB Snaptrade App

  How We Bill at SnapTrade  This document explains every component of SnapTrade s Commercial billing process so you know exactly what you re paying for  when you ll be invoiced  and how payments work   Personal users are currently completely free  Commercial customers may be billed based on connected users  API usage  platform fees  or monthly minimums depending on their agreement  If you are deciding which customer model applies to your integration  start with  SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial            Billing Cycle  SnapTrade bills Commercial customers on a   monthly   cycle  Each invoice covers usage from the 1st through the last day of the previous calendar month  Invoices are generated on the   1st of each month             What We Charge For  A Commercial monthly invoice can include up to four types of charges       1  Connected Users  Tiered Pricing   The primary component of a Commercial bill is based on the number of   unique users   who had an active or inactive brokerage connection during the billing period  A  user  is identified by the  user id  assigned when creating users in your application  For more details on user creation  see the  SnapTrade user creation documentation  https   docs snaptrade com docs getting started getting started users    By default  Commercial customers start with a single flat rate of    2 00 per connected user per month    As your business scales  you can negotiate volume based tiered pricing where additional users above certain thresholds are charged at progressively lower rates  Contact support if you re interested in negotiating bulk tiered pricing     Example of tiered pricing       Tier   User Range   Per User Fee                                         1      0   100      2 00            2      101   500    1 75            3      501          1 50           With 250 connected users in this example  the Commercial bill would be    100 users x  2 00    200 00   150 users x  1 75    262 50     Total   462 50      What counts as a billable user    A user is counted if they had at least one completed brokerage connection or  periodic sync event  https   docs snaptrade com docs syncing  during the billing period  Incomplete connections are not billed       2  Manual Refreshes  If your Commercial agreement with SnapTrade contains pricing for manual refreshes  they will be charged according to the following details   When your application triggers a manual data refresh  sync  for a user s account  each refresh is recorded as a billable event  The default rate is set per Commercial customer based on their agreement with SnapTrade  Manual Sync is available for Pay as you go Daily plans at    0 05 per sync    This feature remains disabled for free plans       3  Recent Orders API Calls  If your Commercial plan includes provisions for the   recentOrders  endpoint  each API call to this endpoint is billed at a per call rate defined in your agreement   Pay as You Go customers have this feature included at no extra charge although this feature may be subject to rate limits at higher volumes       4  Platform Fee   Monthly Minimum  Custom plans may include a fixed   platform fee   that is charged every month regardless of usage  This fee is independent of your user count or API call volume  On custom plans it is possible to bundle in a certain number of connected users with the Platform Fee   Custom plans may include a   monthly minimum fee    If your usage based charges  connected users   manual refreshes   recent orders calls  fall below this minimum  you will be charged the monthly minimum instead  The platform fee  if applicable  is added on top of the monthly minimum           Invoice Total  A Commercial invoice total is calculated as         Connected users charge  accounting for tiered pricing if applicable    Manual refresh charges  if applicable    Recent orders API call charges  if applicable                                              Usage subtotal  or monthly minimum if applicable  whichever is greater    Platform fee  if applicable                                              Subtotal   Sales Tax  if applicable                                              Invoice total              What Happens If an Invoice Goes Unpaid  SnapTrade takes the following steps for overdue Commercial invoices   1    Reminder emails   are sent on the 1st of each month to customers with any invoices past their due date  The email includes the total outstanding amount  your production API key slug  and the date your keys will be disabled if payment is not received   2    API key disablement   occurs automatically after the grace period expires  see Payment Terms table above   The default value for grace period is five  5  business days  When your keys are disabled       Your production API keys stop working       All outstanding unpaid invoices are marked uncollectible in our system but it is still possible to pay them       Invoicing continues so that charges are tracked  but new invoices generated while disabled are also generated in an uncollectible status   3    Automatic re enablement   is checked every hour  Your API keys are automatically restored once       All overdue invoices are paid or voided    and        At least one payment was made   after   the suspension occurred  to confirm the balance has been settled            Viewing Your Billing Details  Commercial customers can use the  SnapTrade Dashboard  https   dashboard snaptrade com settings billing  to view invoices  download PDFs  and manage payment methods           Questions   If you have questions about your Commercial bill or need to discuss your pricing  reach out to your SnapTrade account contact or email the billing address provided in your invoice communications  

How We Bill at SnapTrade

  Build Your Personal Investing App with AI  Use an AI coding assistant to turn your SnapTrade brokerage data into a personal dashboard  portfolio tracker  alerting tool  or investment workflow  This guide gives the assistant the SnapTrade context it needs while keeping your Personal API credentials secure   By the end  you will have a local  read only dashboard that can     List your brokerage accounts   Show balances and buying power   Show positions across your accounts   Show recent orders and account activity   Surface incomplete or broken brokerage connections  You can then ask your coding assistant to add allocation charts  contribution tracking  rebalancing suggestions  alerts  exports  and other features for your own investing workflow      info This guide is for a   SnapTrade Personal   user building an application for their own brokerage accounts  If you only want to ask an AI assistant questions about your portfolio  you can use the  SnapTrade MCP Server  https   docs snaptrade com docs mcp server  without building an app          Choose the Right Way to Build    What you want to do   Use                   Ask ChatGPT  Claude  or another assistant questions about your accounts    SnapTrade MCP Server  https   docs snaptrade com docs mcp server      Build a private dashboard or automation for your own accounts   Personal API key and this guide     Build an app that other SnapTrade Personal users can authorize    SnapTrade OAuth  https   docs snaptrade com docs oauth apps      Build a product that creates and manages brokerage connections for its own users    SnapTrade Commercial  https   docs snaptrade com docs personal vs commercial     A Personal API key represents you  It is appropriate for software you operate for yourself  but it must not be distributed in an app or shared with other people      Before You Begin  You will need     A free  SnapTrade Personal account  https   dashboard snaptrade com signup    At least one brokerage connected in the SnapTrade Dashboard   Two factor authentication enabled on your SnapTrade account   A Personal API key from the  API Key page  https   dashboard snaptrade com api key    Node js and an AI coding assistant that can work with a local project  The examples use TypeScript  Next js  and the SnapTrade TypeScript SDK  The same approach works with another server side framework or with the  SnapTrade Python SDK  https   pypi org project snaptrade python sdk       1  Start a Local Project  Create an empty directory for your dashboard and open it in your coding assistant  Ask the assistant to use a current  stable version of Next js with the App Router and TypeScript   You can start the project yourself      bash npx create next app latest my investing dashboard   typescript cd my investing dashboard npm install snaptrade typescript sdk      Do not paste your SnapTrade credentials into an AI prompt  Add them directly to a local   env local  file      dotenv SNAPTRADE CLIENT ID your personal client id SNAPTRADE CONSUMER KEY your personal consumer key      Confirm that   env local  is ignored by Git before continuing      bash git check ignore  env local      If that command does not print   env local   add   env local  to   gitignore       info title  Keep your credentials private   Your  consumerKey  can access your brokerage data and may be able to trade where trading is enabled  Keep it in server side environment variables  Never expose it in browser JavaScript  commit it to Git  include it in a screenshot  or send it to a logging or analytics service          2  Give Your Coding Assistant the Build Prompt  Copy the prompt below into your coding assistant  You can change the visual direction and feature list  but keep the SnapTrade authentication and security requirements      text Build a private  read only investing dashboard for my own SnapTrade Personal account   Technical requirements    Use Next js App Router and TypeScript    Use the official snaptrade typescript sdk package    Initialize the SDK with SnaptradeAuth personalApiKey using   SNAPTRADE CLIENT ID and SNAPTRADE CONSUMER KEY from server side environment   variables    Put SnapTrade initialization in a server only module    Never send the consumer key  the initialized SnapTrade client  or raw   environment variables to the browser    Do not call registerSnapTradeUser    Do not create  request  or pass a userId or userSecret  The Personal API key   identifies me    Do not implement request signing manually    Do not add any endpoint that places  modifies  or cancels an order    Do not persist or cache raw brokerage responses unless I explicitly ask for   storage and approve its security design    Do not use mock values when a real API request fails  Show a clear error and   retain any other sections that loaded successfully   Build a dashboard that    Lists my accounts with institution  account name  account number suffix    account type  and total value where available    Retrieves balances and unified positions for every account    Shows portfolio value  cash  positions  and allocation by account    Shows recent orders and recent account activity in separate sections    Shows loading  empty  partial data  stale data  and error states    Displays when the data was retrieved    Formats currencies using the currency reported by the API instead of assuming   every account uses USD    Works well on desktop and mobile and meets basic accessibility requirements   Implementation requirements    First inspect the installed SDK s TypeScript types and method signatures  Do   not guess response shapes    Use listUserAccounts  getUserAccountBalance  getAllAccountPositions  and   getAccountActivities where appropriate  Use getUserAccountRecentOrders for   recent orders and listBrokerageAuthorizations for connection status    Keep data fetching on the server    Ensure the portfolio page is rendered dynamically instead of being included   in a static build    Fetch independent account data concurrently without failing the entire page   when one account request fails    Normalize the API responses into small view models before rendering    Avoid logging complete API responses because they contain financial data    Add an  env example containing empty variable names  but never copy values   from  env local    Add a README with setup  local development  security  and troubleshooting   instructions    Add focused tests for data normalization and partial API failures    Run formatting  linting  type checking  and tests when finished   Before editing files  show me  1  The proposed file structure  2  The SnapTrade calls you intend to use  3  Which code runs on the server and which code runs in the browser  4  Any assumptions that need confirmation       Requiring a plan first gives you a chance to catch incorrect authentication  unnecessary complexity  or accidental client side access before the assistant writes the application      3  Check the SnapTrade Client  The generated application should initialize SnapTrade in a server only module similar to this      typescript import  server only    import   Snaptrade  SnaptradeAuth   from  snaptrade typescript sdk    const clientId   process env SNAPTRADE CLIENT ID  const consumerKey   process env SNAPTRADE CONSUMER KEY   if   clientId     consumerKey      throw new Error       SNAPTRADE CLIENT ID and SNAPTRADE CONSUMER KEY must be configured           export const snaptrade   new Snaptrade     auth  SnaptradeAuth personalApiKey       clientId      consumerKey                 For Personal authentication  account calls do not include  userId  or  userSecret       typescript const accounts   await snaptrade accountInformation listUserAccounts     const accountData   await Promise allSettled    accounts data map async  account           const accountId   account id        const  balances  positions    await Promise all         snaptrade accountInformation getUserAccountBalance   accountId           snaptrade accountInformation getAllAccountPositions   accountId                  return         account        balances  balances data        positions  positions data                        Promise allSettled  is useful for a multi account dashboard because one brokerage or endpoint can fail without hiding data from every other account  Your application should still report the partial failure rather than silently omitting it   For more authentication examples  see  Authentication Methods  https   docs snaptrade com docs authentication methods   For the available account endpoints  see  Account Data  https   docs snaptrade com docs account data       4  Run and Verify the Dashboard  Start the development server      bash npm run dev      Before relying on the dashboard  verify     The accounts shown match the SnapTrade Dashboard    Account names and institution names are attached to the correct accounts    The dashboard does not assume every balance or position is denominated in the same currency    Empty accounts display as empty rather than as errors    A failure from one account produces a visible partial data message    Refreshing the page does not place  modify  or cancel an order    Browser developer tools do not expose either SnapTrade credential    Server logs do not contain credentials or complete financial API responses      env local  is ignored by Git and is absent from  git status    Brokerage data may update in real time or on a daily schedule depending on the brokerage and available data access  Display the time your application retrieved the data  but do not label it as a brokerage s last successful synchronization unless the API response provides that value  See  Real time vs Daily Data  https   docs snaptrade com docs realtime data       5  Iterate With Smaller Prompts  Once the first version works  add one capability at a time and ask the assistant to preserve the authentication and security constraints from the original prompt   Useful read only additions include     Allocation by asset class  account  or currency   Dividend and interest income summaries   Deposit and contribution tracking   Portfolio value history   Registered versus non registered account views   CSV export   Threshold alerts for cash  concentration  or allocation drift   A proposed rebalancing plan that does not place orders   A daily or weekly portfolio summary  For example      text Add a read only allocation drift view  Let me define target percentages by asset class  compare them with current positions  and show proposed dollar changes  Do not add trading or order placement calls  Preserve the existing server only SnapTrade client and partial failure behavior  Explain how unknown securities and multiple currencies are handled before implementing the calculation       Treat AI generated financial calculations as software that needs verification  Test totals  signs  currencies  dates  missing prices  option quantities  and other asset specific behavior against known examples before using the output to make decisions      Deploying Your App  You can keep the dashboard local or deploy it to private infrastructure that you control  If you deploy it     Store credentials in the hosting provider s encrypted server side environment settings    Require authentication before serving any portfolio data    Do not use a public  guessable dashboard URL as the only access control    Disable request and response body logging for financial endpoints    Avoid third party analytics  replay  and error reporting tools on pages containing financial data unless you have configured them to exclude sensitive values    Rotate your Personal API key immediately if it may have been exposed   A Personal API key must not be embedded in an application you distribute to other users  If you want other SnapTrade Personal users to connect their accounts  build with  SnapTrade OAuth  https   docs snaptrade com docs oauth apps  instead      Adding Investment Automation  Start by automating observation  scheduled refreshes  summaries  alerts  calculations  and proposed actions  These workflows are easier to inspect and reverse than automated trading   Trading is deliberately outside this guide  If you later add it for your own accounts  treat it as a separate project phase and require     An explicit preview of the exact account  symbol  side  quantity  order type  limit price  and estimated impact   A fresh human confirmation before every submitted order   Maximum order size and daily notional limits   Duplicate order and retry protection   Durable audit logs that omit credentials   A tested kill switch   Clear handling for rejected  partially filled  cancelled  and stale orders  Do not let a language model turn free form text directly into a submitted brokerage order  Review  Trading with SnapTrade  https   docs snaptrade com docs trading with snaptrade  before adding any trading endpoint      Troubleshooting      The assistant asks for  userId  or  userSecret   Stop and correct it  Those credentials belong to the Commercial user model  A Personal API key identifies your SnapTrade user  so Personal account data calls omit both fields       The assistant calls  registerSnapTradeUser   Remove that call  Personal users do not register a subordinate SnapTrade user       The browser can see the consumer key  Move SnapTrade initialization and all API calls into server only code  Environment variables prefixed with  NEXT PUBLIC   are exposed to the browser and must not contain SnapTrade credentials       One brokerage causes the whole page to fail  Fetch independent accounts concurrently  retain successful results  and display the failed account or section explicitly  Do not replace failed responses with invented balances or positions       Data differs from the brokerage  Check the connection status and data freshness before changing calculations  Some brokerages and plans provide daily rather than real time holdings  See  Connections  https   docs snaptrade com docs connections    Fixing Broken Connections  https   docs snaptrade com docs fix broken connections   and  Real time vs Daily Data  https   docs snaptrade com docs realtime data       Related     Getting Started with SnapTrade  https   docs snaptrade com docs getting started     Authentication Methods  https   docs snaptrade com docs authentication methods     SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial     Account Data  https   docs snaptrade com docs account data     SnapTrade MCP Server  https   docs snaptrade com docs mcp server     Build an OAuth App  https   docs snaptrade com docs oauth apps  

Build Your Personal Investing App with AI

  SnapTrade MCP Server  SnapTrade offers a hosted  Model Context Protocol  https   modelcontextprotocol io   MCP  server that lets AI assistants like Claude and ChatGPT securely read a user s connected brokerage data through natural language prompts  Once a user adds SnapTrade as a connector  they can ask their assistant about their balances  positions  orders  and account activity in plain language   The MCP server is available at  https   mcp snaptrade com mcp       info The MCP server is   read only    It can retrieve account data and generate a link to connect a new brokerage  but it cannot place trades  move money  or change account settings  For programmatic access to the full SnapTrade API  including trading  see  Getting Started with SnapTrade  https   docs snaptrade com docs getting started           Before you begin  The SnapTrade MCP server is for   SnapTrade Personal   users   individuals who connect and manage their own brokerage accounts with SnapTrade  It is not used with SnapTrade developer  partner  API keys   To use the connector  you ll need a free SnapTrade Personal account  If you don t have one yet  sign up at the  SnapTrade Dashboard  https   dashboard snaptrade com signup  and link at least one brokerage account before adding the connector to your AI assistant   For a broader comparison of Personal and Commercial customer experiences  see  SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial       What you can do with it  With the SnapTrade connector enabled  an AI assistant can     List the brokerages a user is connected to and the accounts under each connection   Retrieve account details  balances  and buying power   Retrieve positions and holdings across accounts   Review orders  recent orders  and order details   Review historical account activity such as deposits  dividends  and fees   Look up reference data such as currencies  exchange rates  stock exchanges  and security types   Generate a one time link the user can open to connect a new brokerage     How it works  The MCP server is a thin protocol adapter in front of the SnapTrade Partner API  AI assistants speak MCP  SnapTrade exposes a REST API  The MCP server translates between the two and forwards each request to the same endpoints SnapTrade partners already use       AI assistant     SnapTrade MCP server     SnapTrade Partner API     User s brokerages      No new data surface is introduced   the connector exposes a curated  read only subset of existing SnapTrade endpoints      Authentication and security  The connector uses the OAuth 2 0 authorization code grant with PKCE  When a user adds the connector  their AI assistant registers itself automatically using  Dynamic Client Registration  RFC 7591   https   www rfc editor org rfc rfc7591   The user is then redirected to SnapTrade to log in and approve access  Tokens issued to the assistant are scoped to  read   and the MCP server validates every request using  token introspection  RFC 7662   https   www rfc editor org rfc rfc7662  against SnapTrade s authorization server      info The AI assistant never sees a user s SnapTrade  userId  or  userSecret   and never sees brokerage login credentials  It only receives a short lived  read scoped access token  SnapTrade resolves the user from that token       Clients can discover the connector s OAuth configuration at these endpoints      https   mcp snaptrade com  well known oauth protected resource mcp     https   api snaptrade com  well known oauth authorization server mcp   For details on what data the connector accesses and how it is handled  see the  SnapTrade Connector Privacy Notice  https   docs snaptrade com docs connector privacy   For SnapTrade s overall security posture  see  snaptrade com security  https   snaptrade com security       Set up the SnapTrade connector in Claude  1  In Claude  go to   Settings   Connectors    2  Click   Add    then   Add custom connector    3  Enter a name  for example   SnapTrade   and the MCP server URL   https   mcp snaptrade com mcp   4  Click   Add    then   Connect    5  Complete the SnapTrade login flow if prompted and approve   read   access  6  After you approve  the SnapTrade tools become available in Claude      Set up the SnapTrade app in ChatGPT  1  Go to  chatgpt com plugins  https   chatgpt com plugins   click        then   Add custom MCP server    2  Enter a name  for example   SnapTrade    a short description  and the MCP server URL   https   mcp snaptrade com mcp   3  Set authentication to   OAuth    review the warning and select   I understand and want to continue    4  Select   Create as a plugin    then sign in to SnapTrade and approve   read   access when prompted  5  In a new chat  type       and pick   SnapTrade   to use your portfolio data      Example prompts  Once the connector is enabled  a user can ask their assistant questions like       What brokerages am I connected to through SnapTrade        Show me my current balances and positions across all my accounts        What were my last 10 orders across all my accounts        I d like to connect my Alpaca account      the assistant calls  request connection link  and hands the user a one time URL to open in their browser      Available tools  The connector exposes 18 tools  All are read only except  request connection link   which generates a connection link for the user to open     Connections       Connections listBrokerageAuthorizations    list the user s brokerage connections    Connections listBrokerageAuthorizationAccounts    list the accounts under a connection    Account information       AccountInformation getUserAccountDetails    account details  including institution name and total value    AccountInformation getUserAccountBalance    cash balances and buying power    AccountInformation getAllAccountPositions    positions and holdings for an account    AccountInformation getAccountBalanceHistory    historical account balances    AccountInformation getUserAccountOrdersV2    orders for an account    AccountInformation getUserAccountRecentOrdersV2    recent orders for an account    AccountInformation getUserAccountOrderDetailV2    details for a single order    AccountInformation getAccountActivities    historical account activity such as deposits  dividends  and fees    Reference data       ReferenceData listAllCurrencies    supported currencies    ReferenceData listAllCurrenciesRates    exchange rates for all supported currencies    ReferenceData getCurrencyExchangeRatePair    exchange rate for a specific currency pair    ReferenceData getSecurityTypes    supported security types    ReferenceData getStockExchanges    supported stock exchanges    ReferenceData getPartnerInfo    brokerages and data access available to the connector    Connection helpers       list supported brokerages    list the brokerages the user can connect    request connection link    generate a one time URL the user opens to connect a new brokerage  The link is single use and expires after 5 minutes  The assistant cannot complete the connection itself  only the user s browser session can   Every tool is annotated so AI clients and users can tell read operations from write operations  Read tools are marked  readOnlyHint  true  and  destructiveHint  false    request connection link  is marked  readOnlyHint  false  and  destructiveHint  true   All tools are marked  openWorldHint  true       Manage and revoke access  A user can revoke a connector s access at any time from the SnapTrade dashboard under   Settings   Connected apps    Revoking access immediately invalidates the assistant s token   This is separate from disconnecting a brokerage   revoking connector access removes the AI assistant s access to SnapTrade  but leaves the user s brokerage connections intact      Support    General support   support snaptrade com    Security vulnerability reports   security snaptrade com           Related     SnapTrade Connector Privacy Notice  https   docs snaptrade com docs connector privacy     Getting Started with SnapTrade  https   docs snaptrade com docs getting started     Brokerage Integrations  https   docs snaptrade com docs integrations     Terminology  https   docs snaptrade com docs terminology  

SnapTrade MCP Server

  SnapTrade Connector Privacy Notice  This notice explains how the SnapTrade MCP server  the  connector   handles data when you connect SnapTrade to an AI assistant such as Claude or ChatGPT  It supplements the  SnapTrade Privacy Policy  https   snaptrade com privacy policy   which governs SnapTrade s services overall and applies in full  SnapTrade is operated by Passiv Inc   The connector is   read only    it can retrieve your account data and generate a link to connect a new brokerage  but it cannot place trades  move money  or change account settings      What data the connector accesses  When your AI assistant calls a connector tool in response to your prompt  the connector retrieves the following categories of data from SnapTrade and returns them to your assistant       Connections     the list of brokerages you have connected through SnapTrade and connection metadata such as institution name and connection status      Account details     account type  institution name  total account value  and sync status      Balances     cash balances and buying power  including per currency balances      Positions and holdings     the securities held in your accounts  with quantities and market values      Orders     open  filled  cancelled  and pending orders  including order history and individual order details      Account activity     historical transactions such as deposits  withdrawals  dividends  fees  buys  and sells      Reference data     currencies  exchange rates  stock exchanges  and security types  This data is not specific to you   The connector accesses this data   on demand    only in direct response to a prompt you make through your AI assistant  It does not collect or retrieve data proactively      What the connector does not access    The connector never exposes your SnapTrade  userId  or  userSecret  to the AI assistant  These partner level identifiers are stripped from every request before it reaches the assistant    The connector never accesses your brokerage login credentials or passwords    The connector cannot place trades  transfer funds  or change account settings  Access is limited to read only scope      How the connector uses data  The connector is a thin protocol adapter  It uses the data it retrieves solely to fulfill the request you made through your AI assistant  passing the response back to the assistant that asked for it   SnapTrade does not use connector data for advertising or profiling  and does not use it to train AI models      Data storage and retention  The connector is stateless  It does not maintain its own long term store of your account data   each tool call retrieves data from the SnapTrade Partner API and returns it to your assistant   Retention of the underlying account data that SnapTrade holds is governed by the  SnapTrade Privacy Policy  https   snaptrade com privacy policy   OAuth access tokens issued to your AI assistant are short lived and scoped to  read   Operational logs may be retained for security  reliability  and troubleshooting in line with SnapTrade s standard practices      Third party sharing  When a connector tool returns data  that data is delivered to the AI provider you chose to use   Anthropic for Claude  or OpenAI for ChatGPT  How those providers handle the data is governed by their own privacy policies      Anthropic Privacy Policy  https   www anthropic com legal privacy     OpenAI Privacy Policy  https   openai com policies privacy policy    SnapTrade does not sell your personal data  For information on SnapTrade s service providers and other data sharing  see the  SnapTrade Privacy Policy  https   snaptrade com privacy policy       Data minimization  The connector is designed to access the minimum data needed to answer your prompts     It requests only  read  scope   it cannot write to your accounts    It exposes only a curated set of read only endpoints  not the full SnapTrade API    It returns data only in direct response to a prompt  Nothing is collected  just in case     Partner level identifiers and credentials are removed from every request before the AI assistant sees it      Revoking access  You can revoke a connector s access at any time from the SnapTrade dashboard under   Settings   Connected apps    Revoking access immediately invalidates the AI assistant s token  Revoking connector access does not disconnect your brokerages   your SnapTrade connections remain intact  See  SnapTrade MCP Server  https   docs snaptrade com docs mcp server  for more on managing access      Contact  For privacy or data questions  contact  support snaptrade com   For security vulnerability reports  contact  security snaptrade com   SnapTrade is operated by Passiv Inc           Related     SnapTrade Privacy Policy  https   snaptrade com privacy policy     SnapTrade Terms and Conditions  https   snaptrade com terms and conditions     SnapTrade Security  https   snaptrade com security     SnapTrade Application Compliance Policy  https   snaptrade com compliance policy     SnapTrade MCP Server  https   docs snaptrade com docs mcp server  

SnapTrade Connector Privacy Notice

  Terminology     API Keys API Keys consist of a client ID   clientId   and a consumer key   consumerKey    Aliases  app credentials  integration credentials  Learn more   Getting Started  API Keys  https   docs snaptrade com docs getting started getting started api keys    Authentication Methods  https   docs snaptrade com docs authentication methods    FAQ  API Keys  https   docs snaptrade com docs faq faq api keys      Personal Customer A free SnapTrade customer experience for individuals who connect and manage their own brokerage accounts  Personal users can use a Personal client ID and consumer key   Learn more   SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial      Commercial Customer A SnapTrade customer experience for companies and developers building apps for their own end users  Commercial integrations use a client ID and consumer key  create SnapTrade users for app users  and manage connections under those users   Learn more   SnapTrade Personal vs Commercial  https   docs snaptrade com docs personal vs commercial      Client ID The public key for your SnapTrade API key  In direct API requests  it is sent as the  clientId  query parameter      Consumer Key The secret key for your SnapTrade API key  Use the consumer key when generating request signatures or validating webhook signatures  Aliases  client secret     SnapTrade User  A user record under your API key that represents one of your end users and authorizes access to that user s SnapTrade data  Aliases  connected user record  SnapTrade profile  Learn more   Getting Started  Users  https   docs snaptrade com docs getting started getting started users    FAQ  Users  https   docs snaptrade com docs faq faq users      Institution The financial provider a user connects through SnapTrade  such as a broker or exchange  Aliases  broker  brokerage  provider  integration  Learn more   Brokerage Integrations  https   docs snaptrade com docs integrations      Connection An authorized link between a SnapTrade user and one brokerage login that grants data access and optionally trading access  Aliases  brokerage authorization  linked brokerage  authorization  Learn more   Connections  https   docs snaptrade com docs connections    Getting Started  Connections  https   docs snaptrade com docs getting started getting started connections      Connection Portal The hosted SnapTrade UI flow your user completes to create  repair  or upgrade a connection  Aliases  connect flow  linking flow  auth portal  Learn more   Connection Portal  https   docs snaptrade com docs implement connection portal      Disabled Connection A connection state where brokerage authorization is invalid so fresh data and trading actions are blocked until repaired  Aliases  broken connection  disconnected connection  Learn more   Fix Disabled Connections  https   docs snaptrade com docs fix broken connections       Reconnect A re authorization flow that repairs an existing disabled connection by sending the user through the Connection Portal again  Aliases  repair flow  re authorize connection  Learn more   Fix Disabled Connections  https   docs snaptrade com docs fix broken connections      Account A specific brokerage account under a connection that SnapTrade exposes for balances  holdings  activity  and trading  Aliases  portfolio account  trading account  brokerage account  Learn more   Getting Started  Accounts  https   docs snaptrade com docs getting started getting started accounts    Account Data  https   docs snaptrade com docs account data      Balance Cash and buying power values reported for an account  Aliases  cash balance  account cash  Learn more   Account Data  Balances  https   docs snaptrade com docs account data account data balances      Position A holding of a specific asset in an account  typically represented by quantity and market value  Aliases  holding  asset position  Learn more   Account Data  Positions  https   docs snaptrade com docs account data account data positions      Order A brokerage instruction to buy or sell an instrument  including open  filled  canceled  and rejected states  Aliases  trade order  instruction  Learn more   Account Data  Orders  https   docs snaptrade com docs account data account data orders      Transaction A brokerage reported account event that records cash or position movement  such as buys  sells  dividends  fees  deposits  or withdrawals  Aliases  activity  account activity  ledger entry  Learn more   Account Data  Activities  https   docs snaptrade com docs account data account data activities      Periodic Sync The process where SnapTrade updates account data from the connected brokerage  Aliases  data refresh  update cycle  sync  Learn more   Syncing and Data Freshness  https   docs snaptrade com docs syncing      Manual Refresh An explicit API triggered sync request for a connection outside the periodic sync schedule  Aliases  forced sync  on demand refresh  Learn more   Syncing and Data Freshness  https   docs snaptrade com docs syncing      MCP Server SnapTrade s hosted Model Context Protocol server that lets AI assistants securely read a user s connected brokerage data  Aliases  AI connector  Claude connector  ChatGPT app  Learn more   SnapTrade MCP Server  https   docs snaptrade com docs mcp server  

Terminology

  Symbology  SnapTrade returns several symbol identifiers because financial instruments are not identified the same way across brokerages  exchanges  asset classes  and market data vendors  A ticker such as  AAPL  is easy to read  but it is not always enough to uniquely identify a position  match an external identifier such as an ISIN or FIGI code  or place a trade at a specific brokerage   This guide explains the main identifier types and when to use each one      Core concepts      Instrument  An  instrument  is SnapTrade s normalized representation of a financial instrument in newer account data endpoints  It is used for positions returned by endpoints such as  api AccountInformation getAllAccountPositions    Common  instrument  fields include      id   SnapTrade s UUID for the instrument     kind   the instrument type  such as  stock    etf    mutualfund    crypto    future   or  option      symbol   SnapTrade s formatted display symbol  such as  AAPL    VAB TO   or  SPY 220819P00200000      raw symbol   the base symbol without an exchange suffix     description   a human readable name     currency   the currency of the listing or contract     exchange   the exchange SnapTrade associates with the listing or contract     figi instrument   FIGI metadata when available  including  figi code  and  figi share class    The exact fields depend on  kind   For example  an option instrument includes option specific fields such as  option type    strike price    expiration date   and  underlying        Universal symbol  A  universal symbol  is SnapTrade s normalized security model used by legacy and current endpoints  It is still present in many responses and request schemas  including endpoints that refer to  universal symbol id    Common  universal symbol  fields include      id   SnapTrade s UUID for the symbol     symbol   SnapTrade s canonical display symbol  such as  AAPL    VAB TO   or  SPY      raw symbol   the base symbol without an exchange suffix  when applicable     description   a human readable security name     currency   the currency SnapTrade associates with the listing     exchange   the exchange SnapTrade associates with the listing     type   the security type     figi code   the listing level FIGI identifier when available     figi instrument   FIGI metadata when available   Do not assume that  instrument  has fully replaced  universal symbol  everywhere  Use the model returned or required by the endpoint you are calling       Canonical symbol  The  symbol  field is SnapTrade s canonical  human readable symbol or ticker for an instrument  universal symbol or option symbol  It is useful for display  search  and matching user input  Use it for display and user facing workflows  Do not use it as your only permanent cross system identifier        Stocks  ETFs and mutual funds  For stocks  ETFs  and mutual funds  SnapTrade largely follows the  Yahoo Finance ticker format  https   help yahoo com kb SLN2310 html   For example  Toronto Stock Exchange securities usually have a   TO  suffix  while NASDAQ and NYSE securities usually do not have a suffix        Options  For options   symbol  is always the  OCC option symbol  https   en wikipedia org wiki Option symbol The OCC Option Symbol   For example   SPY   220819P00200000  represents a put option on  SPY  with a strike price of  200  expiring on August 19  2022        Futures  For futures   symbol  usually includes the root symbol  month code  and year  For example   ESZ22  represents the E mini S P 500 future expiring in December 2022        Crypto  For cryptocurrencies   symbol  is not normalized between brokerages  While most brokerages supported on SnapTrade will return widely accepted symbols for the various cryptocurrencies  such as  BTC  for Bitcoin  Kraken and other exchanges may instead return  XBT  or  XXBT   These are not normalized in order to make it easier to execute crypto trading  For more details  see  api Trading searchCryptocurrencyPairInstruments  and  api Trading placeCryptoOrder        Option symbol  An  option symbol  is SnapTrade s normalized representation of a specific option contract in legacy current option related responses  While the new  api AccountInformation getAllAccountPositions  endpoint returns a discriminated union as described in the  Instrument  section  all other endpoints currently return an option symbol  We re gradually replacing this legacy construct with the newer discriminated union model   Common  option symbol  fields include      id   SnapTrade s UUID for the option contract     ticker   the OCC option symbol  such as  SPY 220819P00200000      option type    CALL  or  PUT      strike price   the strike price     expiration date   the expiration date     underlying symbol   the underlying  universal symbol    When placing option trades with  api Trading placeMlegOrder   use the OCC option symbol in  legs   instrument symbol        Brokerage instrument  A brokerage instrument describes what a brokerage can support for trading   api ReferenceData listAllBrokerageInstruments  returns brokerage level instruments with fields such as      symbol   the brokerage trading symbol  in canonical SnapTrade format     exchange mic   the exchange MIC code  when available     tradeable   whether the brokerage reports the instrument as tradeable   null  means SnapTrade does not know     fractionable   whether the brokerage reports support for fractional units   null  means SnapTrade does not know     universal symbol id   the related SnapTrade universal symbol ID  when available   Brokerage level support is not the same as account level permission  A symbol can be listed as tradable by the brokerage while a specific account is read only  restricted  or not approved for that asset class      Read use cases  When reading account data  treat SnapTrade symbol fields as normalized metadata about what the brokerage returned  Choose the identifier based on the job you are doing     Use case   Recommended fields                   Display a position or activity to a user    instrument symbol    instrument description    instrument currency   and  instrument exchange      Match a security to your own security master   Prefer  figi instrument figi code  or  figi code  when present  Otherwise use  symbol  plus  exchange   with  currency  as supporting context      Aggregate the same share class across venues   Use  figi instrument figi share class  when present  Do not treat it as a listing level identifier      Reconcile SnapTrade responses over time   Store SnapTrade s  instrument id  or  universal symbol id  when present  plus  symbol    exchange    currency   and FIGI fields        Instrument search  For stock  ETF and mutual fund trading flows  avoid depending on real time symbol search at order entry time  Instead  cache the brokerage instrument list returned by  api ReferenceData listAllBrokerageInstruments  and use that cache to resolve user input to brokerage supported symbols      Trade use cases  Trading is account specific  For order placement  use the identifier required by the trading endpoint and the connected brokerage account  Avoid using an  instrument id  or  universal symbol id  and prefer passing a symbol directly  Do not assume that every brokerage instrument is available for trade for a given account   For detailed information and recommendations around trading  see  Trading with SnapTrade  https   docs snaptrade com docs trading with snaptrade       Practical recommendations    Use  instrument  for newer account data responses and  universal symbol  where the endpoint still returns or requires it    Use  symbol  for display  user input  and standard equity order placement    Use an OCC option symbol for option quotes and option order legs    Store SnapTrade IDs when available  but keep  symbol    exchange    currency   and FIGI fields for reconciliation and debugging    Prefer FIGI for matching against external systems  Use  figi code  for listing level matching and  figi share class  for share class aggregation    Treat  tradeable  and  fractionable  as brokerage level  nullable fields   null  means unknown  

Symbology

  Sending Requests  When sending requests to SnapTrade  we recommend using an SDK  You can also send requests directly through the API reference on this site  this is especially useful for managing users and connections during development      SDKs  It is possible to integrate without an SDK  but you will need to generate a request signature for each API request  See  Request Signatures  https   docs snaptrade com docs request signatures  for the signing algorithm and code examples   SnapTrade provides the following SDKs for you to use       Language       SDK Link                     Python      https   pypi org project snaptrade python sdk    https   pypi org project snaptrade python sdk      TypeScript      https   www npmjs com package snaptrade typescript sdk    https   www npmjs com package snaptrade typescript sdk      Java      https   central sonatype com artifact com snaptrade snaptrade java sdk    https   central sonatype com artifact com snaptrade snaptrade java sdk      Ruby      https   rubygems org gems snaptrade    https   rubygems org gems snaptrade      C       https   nuget org packages SnapTrade Net    https   nuget org packages SnapTrade Net      PHP      https   packagist org packages konfig snaptrade php sdk    https   packagist org packages konfig snaptrade php sdk      Go      https   pkg go dev github com passiv snaptrade sdks sdks go    https   pkg go dev github com passiv snaptrade sdks sdks go        Ratelimiting  The SnapTrade API uses a number of safety mechanisms to protect against bursts of incoming traffic and help maximize its stability   Sending many requests in quick succession might trigger error responses that show up as HTTP status code 429      Response Headers      x request id  Each SnapTrade API request has an associated request identifier  If you need to contact us about a specific request  providing the request identifier is helpful to ensure the fastest possible resolution       x ratelimit limit  With each request  you will receive your ratelimit as a header  This denotes how many requests you can make in one minute before being throttled       x ratelimit remaining  Within each request  you will receive how many requests are remaining until SnapTrade begins throttling your requests         See also     Request Signatures  https   docs snaptrade com docs request signatures     Ratelimiting  https   docs snaptrade com docs ratelimiting     Request IDs  https   docs snaptrade com docs request ids  

Sending Requests

  Request Signatures  SnapTrade API requests made with a  clientId  and  consumerKey  are authenticated with a Unix  timestamp  query parameter and a  Signature  header   The official SnapTrade SDKs generate request signatures automatically  You only need to implement this flow manually if you are calling the SnapTrade API directly without an SDK      Overview  To generate a request signature   1  Add  clientId  and  timestamp  to the request query string  2  Build a signature payload containing the request body  path  and query string  3  Serialize the payload into canonical JSON  4  Sign the canonical JSON string using HMAC SHA256 with your  consumerKey   5  Base64 encode the HMAC digest  6  Send the encoded value in the  Signature  header      Signature Payload  The signature payload is a JSON object with exactly three fields     Field   Description                content    The JSON request body  Use  null  when the request has no body or the body is empty       path    The request path  including   api v1   excluding the query string       query    The raw query string exactly as sent in the request URL  excluding the leading         Example request      http POST  api v1 symbols clientId YOUR CLIENT ID timestamp 1715123456 Signature   generated signature  Content Type  application json    substring   AAPL        The signature payload for this request is      json      content          substring    AAPL          path     api v1 symbols      query    clientId YOUR CLIENT ID timestamp 1715123456            Canonical JSON Rules  Before signing  the signature payload must be serialized into a canonical JSON string   Use these rules   1  Sort object keys alphabetically at every level  2  Remove unnecessary whitespace  3  Encode the resulting string as UTF 8  4  Use  null  for empty request bodies   The canonical signature string for the example above is      json   content    substring   AAPL    path    api v1 symbols   query   clientId YOUR CLIENT ID timestamp 1715123456        The following string represents the same JSON object  but it is not valid for signing because it contains extra whitespace      json   content     substring    AAPL     path     api v1 symbols    query    clientId YOUR CLIENT ID timestamp 1715123456        Cryptographic signatures are generated from the exact bytes of the string  Even small formatting differences will produce a different signature      Request Details  The  query  value is the exact query string sent in the request URL  excluding the leading       Example      text  api v1 symbols clientId YOUR CLIENT ID timestamp 1715123456      Use      text clientId YOUR CLIENT ID timestamp 1715123456      Do not sort  decode  re encode  or otherwise modify query parameters before signing   For requests without a body  set  content  to  null   This includes GET requests  bodyless DELETE POST requests  and requests where the body would otherwise be           End to End Example  This example signs a direct API request for the symbol search endpoint  Replace  YOUR CLIENT ID  and  YOUR CONSUMER KEY  with your API key values  If your request includes additional query parameters  include those exact parameters in the URL and in the signature payload s  query  value      http POST  api v1 symbols clientId YOUR CLIENT ID timestamp 1715123456 Signature   generated signature  Content Type  application json    substring   AAPL            Python Example     python from base64 import b64encode import hashlib import hmac import json import time import typing from urllib parse import urlencode   def compute request signature path  str  consumer key  str  body  typing Any   None     str      subpath  query   path split      1      sig object              content   None if body is None or body       else body           path     api v1 s    subpath           query   query            sig content   json dumps sig object  separators             sort keys True      sig digest   hmac new consumer key encode    sig content encode    hashlib sha256  digest       return b64encode sig digest  decode     query   urlencode   clientId    YOUR CLIENT ID    timestamp   int time time      resource path   f  symbols  query   request body     substring    AAPL   signature   compute request signature resource path   YOUR CONSUMER KEY   request body           TypeScript Example  Node js      typescript import   as crypto from  crypto    function JSONstringifyOrder obj  Record string  unknown    string     const allKeys  string           const seen  Record string  null          JSON stringify obj  function  key  value        if    key in seen           allKeys push key         seen key    null            return value          allKeys sort      return JSON stringify obj  allKeys      function computeHmacSha256 message  string  key  string   string     const hmac   crypto createHmac  sha256   key     hmac update message     return hmac digest  base64       const clientId    YOUR CLIENT ID   const consumerKey    YOUR CONSUMER KEY   const timestamp   Math floor Date now     1000    const requestPath     api v1 symbols   const requestQuery   new URLSearchParams     clientId    timestamp  timestamp toString       toString     const requestData     substring   AAPL      const sigObject       content  requestData    path  requestPath    query  requestQuery      const sigContent   JSONstringifyOrder sigObject   const signature   computeHmacSha256 sigContent  consumerKey            Java Example     java import javax crypto Mac  import javax crypto spec SecretKeySpec  import java nio charset StandardCharsets  import java security InvalidKeyException  import java security NoSuchAlgorithmException  import java util Base64   public class Example       private static byte   calculateHmacSha256 String message  String key              throws NoSuchAlgorithmException  InvalidKeyException           SecretKeySpec secretKeySpec   new SecretKeySpec key getBytes StandardCharsets UTF 8    HmacSHA256            Mac mac   Mac getInstance  HmacSHA256            mac init secretKeySpec           return mac doFinal message getBytes StandardCharsets UTF 8               private static String encodeBase64 byte   bytes            return Base64 getEncoder   encodeToString bytes              public static void main String   args  throws NoSuchAlgorithmException  InvalidKeyException           String clientId    YOUR CLIENT ID           String consumerKey    YOUR CONSUMER KEY           long timestamp   System currentTimeMillis     1000L           String path     api v1 symbols           String queryString    clientId     clientId     timestamp     timestamp          String requestBody       substring     AAPL              String data   String format     content    s   path      s     query      s      requestBody  path  queryString           String signature   encodeBase64 calculateHmacSha256 data  consumerKey                     Go Example     go package main  import     bytes    crypto hmac    crypto sha256    encoding base64    encoding json    fmt    net url    sort    strings    time     func computeHmacSha256 message string  key string  string    h    hmac New sha256 New    byte key    h Write   byte message    return base64 StdEncoding EncodeToString h Sum nil      func main      clientId     YOUR CLIENT ID   consumerKey     YOUR CONSUMER KEY   timestamp    time Now   Unix     requestPath      api v1 symbols   query    url Values    query Set  clientId   clientId   query Set  timestamp   fmt Sprintf   d   timestamp    requestQuery    query Encode     requestData    map string interface    substring    AAPL     sigObject    map string interface       content   requestData     path      requestPath     query     requestQuery       sortedSigObject    make map string interface     keys    make   string  0  len sigObject    for k    range sigObject     keys   append keys  k      sort Strings keys   for    k    range keys     sortedSigObject k    sigObject k       var sigContent bytes Buffer  encoder    json NewEncoder  sigContent   encoder SetEscapeHTML false   encoder Encode sortedSigObject    signature    computeHmacSha256 strings TrimSuffix sigContent String      n    consumerKey       signature           Query Parameters  The same signing rules apply to every authentication mode that uses  clientId    timestamp   and  Signature   Sign the exact query string you send  For example  a request with additional query parameters signs those parameters as part of  query       http POST  api v1 symbols clientId YOUR CLIENT ID timestamp 1715123456 userId YOUR USER ID userSecret YOUR USER SECRET Signature   generated signature  Content Type  application json    substring   AAPL       

Request Signatures

  Brokerage Integrations  SnapTrade connects your app to 450M  retail investor accounts across 40  financial institutions around the world  Sometimes a single institution can have multiple integrations depending on geography or account type  For example we support Webull USA and Webull Canada as two distinct integrations  Similarly  Alpaca and Alpaca Paper are two distinct integrations despite belonging to the same company  For in depth information on each brokerage that we support  please refer to  SnapTrade Brokerage Integrations  https   support snaptrade com brokerages   

Brokerage Integrations

  Connections  A connection is an open channel for accessing brokerage account data  In Commercial integrations  connections belong to the end users of your app  in Personal API key integrations  connections provide access to your own brokerage data  Each connection is associated one to one with a set of credentials to an institution  If the access token for the connection is no longer valid  the connection will become disabled and the end user will need to go through the connection portal again to enable the connection      Connection Portal  The Connection Portal is a UI widget designed to allow users to securely connect brokerage accounts to SnapTrade powered applications  It handles brokerage selection  OAuth redirects  username password authentication  and multi factor auth verification in one flow      Disabled Connections  Connections can break for a variety of reasons  which are usually related to security needs  Access tokens usually have some sort of expiry associated with them  so that users occasionally need to reauthorize access in order to show that they still approve of the connection  Access tokens typically expire after a few weeks and need to be reauthorized occasionally   When an access token is no longer valid  SnapTrade considered this to be a  disabled connection  which will no longer provide live data until it is repaired by the user        See also     Fix Broken Connections  https   docs snaptrade com docs fix broken connections     Integrate the Connection Portal into Your Application  https   docs snaptrade com docs implement connection portal implement connection portal integrate the connection portal into your application  

Connections

  Account Data  An account represents a unique account at a brokerage  like an individual account  or a 401k retirement account  A connection can have multiple accounts  The same brokerage account can also belong to multiple connections  For example a joint account between two individual account holders are visible under each account holder s connection  With a connected account  you can call any SnapTrade account data API to get information about the account  its holdings  and its history      Account Details   api AccountInformation getUserAccountDetails   The account object contains information such as the institution name  the sync status of the account and the total market value of the account      Positions   api AccountInformation getAllAccountPositions   Positions are the current holdings of the account excluding cash  This includes many asset classes such as stocks  ETFs  and fixed income      Balances   api AccountInformation getUserAccountBalance   Balances are the current cash holdings and buying power of the account  In some cases  brokerages will allow holding many currencies in an account and these will be returned as separate balances      Orders   api AccountInformation getUserAccountOrders   api AccountInformation getUserAccountRecentOrders   Orders are how a broker keeps track of trading activity in an account  This differs from account activities in the following ways     Is updated intraday   Contains all orders placed at the broker regardless if they resulted in a change in position  including cancelled orders and pending orders   Often has more granular timestamps than account activities   Only looks back a few months at most     Activities   api AccountInformation getAccountActivities   Activities record the transaction history for the account  Each activity documents a change in position for the account  including deposits  withdrawals  fees  dividends  buys and sells  This differs from Orders in the following ways     Activities are updated once daily   Activities may not have timestamps of when the transaction occurred  only the date    Activities only contain transactions that resulted in a change of position to the account  no pending or cancelled orders   Often has years of history for the account  sometimes the entire account history since inception  SnapTrade classifies common transactions under the predefined types  with extra focus on what we consider the most important types  buys  sells  contributions  dividends  withdrawals  etc   When we encounter a transaction with a type that doesn t fit into one of our common types  we will return the type that the brokerage uses to identify it   We usually recommend you try not to individually handle every type beyond the most common ones  and instead rely on the other fields  amount  units  price  symbol  option symbol  etc  If amount is positive it represents gaining cash  if amount is negative it represents spending cash  Same with units  so a BUY for instance would have positive units and negative amount  a sell would be negative units positive amount   Check  our API Spec  https   docs snaptrade com reference Account 20Information AccountInformation getAccountActivities  for some of the most common transaction types        See also     Webhooks  https   docs snaptrade com docs webhooks     Getting Started with SnapTrade  https   docs snaptrade com docs getting started  

Account Data

  Syncing and Data Freshness  First  confirm whether your API key uses the   Real time   or   Daily   data freshness option on the  Customer Dashboard billing page  https   dashboard snaptrade com settings billing   See  Real time vs Daily plans  https   docs snaptrade com docs realtime data  for a comparison and recommended application flows   If a  connection is disabled  https   docs snaptrade com docs fix broken connections   fresh data cannot be fetched on either plan until the connection is fixed   For both plans  transactions are cached  updated once per day with the daily sync  and delayed by one day  Intraday transactions are not available  If you need intraday trade activity   compare orders with transactions  https   docs snaptrade com docs account data account data orders    If you need to know when transactions or holdings data on Daily plans have synced  use webhooks or the account sync status      Webhooks     ACCOUNT TRANSACTIONS UPDATED  https   docs snaptrade com docs webhooks webhooks account transactions updated  is sent when SnapTrade creates a new transaction for an account  No webhook is sent if a transaction sync finds no new data     ACCOUNT HOLDINGS UPDATED  https   docs snaptrade com docs webhooks webhooks account holdings updated  is sent once per day when holdings are updated  whether or not the data changed  This is primarily useful for Daily plans because Real time plans refresh supported holdings data when it is requested      API account status   List accounts for a connection  https   docs snaptrade com reference Connections Connections listBrokerageAuthorizationAccounts  returns a  sync status  object for each account  It reports when the daily holdings sync last ran and the last day for which transactions   have been fully synced   from 00 00 through 23 59   If a user has multiple connections  first call  api Connections listBrokerageAuthorizations   then call  api Connections listBrokerageAuthorizationAccounts  for each connection      json      sync status          transactions            initial sync completed   true         last successful sync    2022 01 24          first transaction date    2022 01 24              holdings            initial sync completed   true         last successful sync    2024 06 28 18 42 46 561408 00 00                      Request an intraday holdings update  On a Daily plan  call the  Refresh connection endpoint  https   docs snaptrade com reference Connections Connections refreshBrokerageAuthorization  when an intraday holdings update is needed  Additional charges may apply to each call  see the  Customer Dashboard billing page  https   dashboard snaptrade com settings billing  for pricing   If you need to control the time of day when transactions are updated  contact the SnapTrade team about  a custom plan  https   snaptrade com pricing   

Syncing and Data Freshness

  Request IDs  Each SnapTrade API request has an associated request identifier   You can find this value in the response headers  under  X Request ID   For example  running a simple  curl  request and glancing at the headers for the response will give something like this       curl  v https   api snaptrade com api v1         date  Fri  13 Oct 2023 00 32 06 GMT   content type  application json   content length  71   server  gunicorn   vary  Accept  DNT  origin  Cookie   allow  GET  HEAD  OPTIONS   x frame options  DENY   x request id  27fcf193c58c4a646aa9fd90e833ab29   x content type options  nosniff   referrer policy  same origin   cross origin opener policy  same origin      If you need to contact us about a specific request  providing the request identifier will ensure the fastest possible resolution  

Request IDs

  Fix Disabled Connections  A SnapTrade connection provides direct access to a user s trading account  When an access token is no longer valid  SnapTrade considered this to be a  disabled connection  which will no longer provide live data until it is repaired by the user     Required Functionalities  It is important that users are directed to  fix connections  rather than they create new ones  This allows you to provide a better experience to the user  minimize the number of disabled connections you are managing  and retain historical session data  Using the Connection Portal in the normal manner will create new connections  which will have a different connection id and different account ids if successful  as well as will leave the disabled connection to remain   It is a requirement to implement the ability to reconnect so that connections can be fixed  There are mechanisms available to be notified when connections break  either through a   webhooks   docs webhooks  as described below  or b  by polling the connections endpoint   api Connections listBrokerageAuthorizations   for each user and checking the  disabled  status  When  disabled    true   the connection is disabled and the user must take an action to fix it     How to fix a disabled connection  SnapTrade s Connection Portal has a special mode that s designed for fixing connections  rather than creating new ones  To use the reconnect mode  you simply pass along the connection id in the  reconnect  field as part of the request to generate a login link  See  api Authentication loginSnapTradeUser    When the Connection Portal is accessed with the  reconnect  parameter  it will immediately take the user into the appropriate reconnection flow for that connection  When successful  the disabled connection will be updated with a new access token and start working again   Note  It is important that the user logs into the same brokerage connection when attempting to reconnect  Changing the connection in a reconnect is not permitted and will return an error  If the user wishes to change the connection  they should delete the old connection and create a new one to the new trading account     Webhooks  SnapTrade provides webhooks to notify when new connections are     Attempted   Added   Updated   Deleted   Broken   Fixed  If you have a webhook listener URL associated with your SnapTrade account  you will automatically receive webhook events to let you know when any of those events take place  This is especially useful for noticing when connections break so that you can inform the user that they need to reconnect   Review the documentation on  SnapTrade Webhooks   docs webhooks  for more detail  sample payloads  etc  

Fix Disabled Connections

  Broker Access Guide  Start building in minutes  The majority of SnapTrade s  brokerage integrations  https   docs snaptrade com docs integrations  are live the moment your  Production Access Application  https   dashboard snaptrade com production access  is approved  For the few brokers that work differently  this page breaks down exactly what to expect   The   free plan   includes up to 5 brokerage connections  with no additional steps required to access any integration   Brokerages become available on your production keys in one of three ways   1  Immediately 2  After broker approval 3  By bringing your own API keys     Available immediately  These brokers are available to your users as soon as your SnapTrade Production Access Application is approved  Complete your profile  get approved  and start connecting     Broker   Access Level               AJ Bell   Read Only     Binance   Read and Trade     BUX   Read Only     Coinbase   Read and Trade     CommSec   Read Only     Degiro   Read Only     E  TRADE   Read and Trade     eToro   Read Only     Interactive Brokers   Read Only     Kraken   Read and Trade     Moomoo   Read and Trade     Public   Read and Trade     Questrade   Read Only     Robinhood   Read Only     Stake Australia   Read and Trade     tastytrade   Read and Trade     TD Direct Investing   Read Only     Trading212   Read and Trade     Trading212 Practice   Read and Trade     Upstox   Read Only     Vanguard US   Read Only     Wealthsimple   Read and Trade     Webull CA   Read and Trade     Webull US   Read and Trade     Zerodha   Read Only       Available after broker approval  Some brokers require a production approval step before connections go live  Once your Production Access Application with SnapTrade is completed  we submit these applications automatically   no extra steps on your end  You ll just need to allow a few days for these to come online     Broker   Access Level   Estimated Turnaround   Instructions   Status                           Chase   Read Only    2 business days   Fill out app profile   Generally available     Citi   Read Only    2 business days   Fill out app profile   Beta     Edward Jones   Read Only    2 business days   Fill out app profile   Alpha     Empower   Read Only    2 business days   Fill out app profile   Generally available     Fidelity   Read Only    2 business days   Fill out app profile   Generally available     PNC   Read Only    2 business days   Fill out app profile   Alpha     Schwab   Read Only    1 week   Fill out app profile   Generally available     TIAA   Read Only    2 weeks   Fill out app profile   Alpha     Transamerica   Read Only    2 business days   Fill out app profile   Alpha     US Bank   Read Only    1 week   Fill out app profile   Beta     Wells Fargo   Read Only    2 business days   Fill out app profile   Generally available       Bring your own API keys  A small number of brokers require you to apply for API credentials directly with the broker  These are the only integrations where you ll need to take action beyond completing the Production Access Application  Once you have your keys  add them to your SnapTrade dashboard and you re good to go   Every broker in this section requires your own API keys  Use the table below to understand the steps needed for each     Broker   Access Level   Estimated Turnaround                   Schwab   Trading   Case by case basis     Alpaca   Read and Trade    4 weeks     TradeStation   Read and Trade    2 weeks     Tradier   Read and Trade    2 weeks        Schwab  To enable Schwab OAuth with Trading access   1  Register for Accounts and Trading commercial access  on the Schwab developer portal  https   developer schwab com products trader api  commercial   2  When prompted  set the callback URL to  https   connect snaptrade com oauth callback   3  Once approved by Schwab  send your API keys securely to SnapTrade  for example  via Bitwarden  at  support snaptrade com  mailto support snaptrade com        Alpaca  1  Go to  https   alpaca markets oauth  https   alpaca markets oauth  and click   Submit Your App    2  Navigate to   Alpaca Connect   My Developed Apps   Submit Your App    3  Complete the application form  setting the callback URL to  https   connect snaptrade com oauth alpaca   4  After you submit  Alpaca generates your API key  Client ID and Secret   5  Send the keys securely to SnapTrade  for example  via Bitwarden  at  support snaptrade com  mailto support snaptrade com    Note  Alpaca approval can take up to 30 days after keys are issued  Canadian developers are not supported at this time       TradeStation  1  Email  ClientExperience tradestation com  mailto ClientExperience tradestation com  to request your API key  and ask that the callback URL be set to  https   connect snaptrade com oauth tradestation   2  Once approved by TradeStation  send your API keys securely to SnapTrade  for example  via Bitwarden  at  support snaptrade com  mailto support snaptrade com    Use the simulated trading environment for testing       Tradier  1  Sign up for Partner API access at  developer tradier com  https   developer tradier com login   2  Reach out to Tradier s business development team and complete their partner survey  3  Set the callback URL to  https   connect snaptrade com oauth tradier   4  Tradier will review your application and follow up directly  5  Once approved by Tradier  send your API keys securely to SnapTrade  for example  via Bitwarden  at  support snaptrade com  mailto support snaptrade com    Notes     Developers are charged a one time fee of  500  Onboarding with Tradier is optional    By default  Tradier access tokens expire after 24 hours  If you need users to remain connected without reauthorizing  request that refresh tokens be enabled for your application  This requires Tradier s approval   email  techsupport tradier com  mailto techsupport tradier com  to start the process      Next steps   Sign up for SnapTrade  https   dashboard snaptrade com signup  and start connecting broker accounts today  If you have questions about a specific broker or integration  reach out to the SnapTrade team at  support snaptrade com  mailto support snaptrade com   

Broker Access Guide

  Frequently Asked Questions  Need a quick definition while reading  See  Terminology  https   docs snaptrade com docs terminology       API Keys      I have lost the consumerKey to my API Key  What should I do   You should reach out to SnapTrade support  If a Commercial key is compromised  user scoped calls also require a  userSecret   but you should still contact SnapTrade support immediately  Personal API keys represent the Personal user directly and should be treated as sensitive credentials           Requests      I am getting a  Unable to verify signature sent  error when making a request to the API  What should I do   The API call is failing when comparing the expected signature to the signature provided by your client  This can happen for many reasons  but is likely caused by attempting to configure the signature without an SDK  or an invalid consumerKey  If you need to reset your consumerKey  reach out to someone in SnapTrade staff           Users      What is a  Connected User    A connected user is a user who has at least one connection  If someone connects both a Wealthsimple Trade and Questrade account  then that person will be counted as one connected user  Similarly if they have multiple accounts  IRA and margin  at one broker  then that s also counted as one connected user   A user is considered a connected user from the moment they successfully complete the first connection process to when you or the user deletes their last connection  some times users have multiple brokers connected   You can handle this on your end or let the users delete the connections from your platform       What should I do if I lose the userSecret of one of my users   Commercial only   If you lose the  userSecret  for a Commercial SnapTrade user  the easiest thing to do is create a new user and ask the end user to reconnect  Personal API key users do not have a  userSecret          The userSecret to one of my SnapTrade users has been compromised  What should I do   Commercial only     The best thing to do in this case is to rotate the user secret using  api Authentication resetSnapTradeUserSecret            Connections      What is the format of   disabled date     All of our timestamp fields return datetime in ISO 8601 format       What is the difference between an account and a connection     image png    assets 250312 model png   The accounts live under the connection to the brokerage  Each connection is associated one to one with a set of credentials to the brokerage  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       If I want to remove an account do I need to delete the connection   If you want to remove an account  you will need to delete the corresponding connection  You can do this using  api Connections removeBrokerageAuthorization        If I delete connection  will it delete all accounts from that Connection  Can I delete only one account   Deleting the connection will remove all accounts under that connection  Instead of deleting individual accounts  you could mark them as hidden on your end and only pull information from accounts that are not hidden       How can I force a connection to become disabled for testing   You can do this with the  api Connections disableBrokerageAuthorization  endpoint       How do I enable connecting to  X  broker on my API Key   By default  all brokers which can be enabled for you are enabled  For now  broker configuration is done manually on our end  Certain brokers require an application to enable the integration  Alpaca  Tradier  Tradestation  Questrade  Fidelity   Please reach out if you need access to one of these           Account Information      What kind of accounts does SnapTrade support   We support all kinds of accounts and it is brokerage dependent  In general  if the brokerage returns it to us  we will return it over the API  You can refer to the  SnapTrade Broker Support Matrix  https   support snaptrade com brokerages  and the field will be returned over the  raw type  on the account object       How do I determine if an activity indicates the position was bought or sold   If the activity resulted in a gain in position to the account  long   the activity will have a positive unit  If the activity resulted in a loss of position to the account  short   the activity will have a negative unit       Is it possible to know a stock s first purchase date   Determining a stock s first purchase date varies by brokerage  Two key requirements must be met   1  The brokerage must provide activities or transaction data that includes historical buy sell records  2  The brokerage must include complete transaction history in the account data   Some brokerages have data retention limits for example  Schwab only provides up to 4 years of historical data  You can check this here  SnapTrade Broker Support Matrix  https   support snaptrade com brokerages       When does account data get synced daily   It is not consistent at the same time every day  but guarunteed once per day       My account data is stale  why is my account not syncing every day   The connection is probably disabled  this happens when the access token is no longer valid  Please check using the  api Connections detailBrokerageAuthorization  and follow  this guide  https   docs snaptrade com docs fix broken connections  to repair the connection       How can I tell the difference between asset classes   Each symbol will have a  type  property  This will contain a short code representing the security type  For example   cs  for Common Stock  Here are some common values    ad    ADR  bnd    Bond  cs    Common Stock  cef    Closed End Fund  crypto    Cryptocurrency  et    ETF  oef    Open Ended Fund  ps    Preferred Stock  rt    Right  struct    Structured Product  ut    Unit  wi    When Issued  wt    Warrant          Trading      Is there a comprehensive list of symbol IDs that I can use for submitting trades   A symbol is not guaranteed to be stable  Since a stock is able to be traded on multiple exchanges  you should get the symbol with  api Trading getUserAccountQuotes  at the time you want to place the trade       

Frequently Asked Questions

  Sandbox  A simulated brokerage for exercising your integration end to end   connection flow  accounts  balances  holdings  orders  and transactions   without a real brokerage login  It returns deterministic data and lets you trigger specific success and failure outcomes      Getting access    Sandbox is available on   non production   keys   both   personal keys   and   commercial test keys     and is   enabled by default    so there s nothing to request    It is   not available on commercial production keys    and can t be enabled on them    In the connection portal it s flagged   For testing only     pinned to the   top   of the institution list on commercial test keys  and shown at the   bottom   on personal keys     Sandbox in the connection portal  flagged  For testing only     assets sandbox portal png      Connecting  1  Generate a Connection Portal URL as usual   loginSnapTradeUser   and use a   read   connection type  Optionally pass  broker SANDBOX  to jump straight past the institution list  skipping step 2  2  Select   Sandbox    3  Pick a   scenario   to simulate     Connect        Scenarios    Data   connection succeeds         Self directed    default    2 funded accounts with positions  orders  and transaction history     Cash only     1 cash account  no holdings     No transactions     accounts with positions but no activity history     No accounts     succeeds but returns zero accounts    Errors   connection fails         Invalid credentials     invalid credentials error     Account locked     account locked error     Rate limited     rate limit error     What the data covers  data scenarios     Accounts  balances  cash   buying power   and positions across a handful of well known tickers   Orders spanning every status   executed  partially filled  accepted  canceled  rejected   Transactions spanning   trades      cash   fees      dividends   income      corporate actions    and   transfers    see the full list of types below    In the default   Self directed   scenario these are   spread across the two accounts    e g  splits   dividends on one  transfers   mergers on the other    iterate   all   accounts to see the full set   details   summary  b All transaction types  b   summary   These are the normalized  type  values SnapTrade maps real brokerage transactions to  the Sandbox exercises most of them across its data scenarios   The list is   not exhaustive    when a brokerage transaction doesn t map to one of these  SnapTrade returns the raw type the brokerage uses  so treat  type  as open ended and lean on  amount    units    price   and  symbol  where you can     Category   Type   Description                         Trades    BUY    Asset bought      Trades    SELL    Asset sold      Cash   fees    CONTRIBUTION    Cash contribution  deposit  into the account      Cash   fees    WITHDRAWAL    Cash withdrawal from the account      Cash   fees    INTEREST    Interest deposited into the account      Cash   fees    FEE    Fee withdrawn from the account      Cash   fees    TAX    A tax related fee      Cash   fees    REBATE    A rebate credited to the account      Dividends   income    DIVIDEND    Dividend payout      Dividends   income    REI    Dividend reinvestment      Dividends   income    STOCK DIVIDEND    Dividend distributed as shares instead of cash      Dividends   income    RETURN OF CAPITAL    Return of capital distribution      Dividends   income    DISTRIBUTION    A distribution paid into the account      Options    OPTIONEXPIRATION    Option expiration event      Options    OPTIONASSIGNMENT    Option assignment event      Options    OPTIONEXERCISE    Option exercise event      Corporate actions    SPLIT    A stock share split      Corporate actions    REVERSE SPLIT    A reverse stock share split      Corporate actions    SPINOFF    Shares received from a corporate spinoff      Corporate actions    STOCK MERGER    Shares resulting from a merger      Corporate actions    ADJUSTMENT    A one time adjustment of the account s cash balance or shares of an asset      Transfers    TRANSFER    Transfer of asset s  from one account to another      Transfers    EXTERNAL ASSET TRANSFER IN    Incoming transfer of an asset from an external account      Transfers    EXTERNAL ASSET TRANSFER OUT    Outgoing transfer of an asset to an external account      Transfers    INTERNAL CASH TRANSFER IN    Incoming cash transfer between your own accounts      Transfers    INTERNAL CASH TRANSFER OUT    Outgoing cash transfer between your own accounts      Transfers    INTERNAL ASSET TRANSFER IN    Incoming asset transfer between your own accounts      Transfers    INTERNAL ASSET TRANSFER OUT    Outgoing asset transfer between your own accounts       details      Limitations      Read only     placing canceling trades isn t supported  and Sandbox won t appear in   trade only   connection sessions   Data is   static and simulated    timestamps are relative to the current time  

Sandbox

Check whether the API is operational and verify timestamps.

Get API Status

Returns a list of all registered user IDs. Please note that the response is not currently paginated.

List all users

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


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

Delete user

Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app.

Please note that the returned URL expires in 5 minutes.


Generate Connection Portal URL

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.


Rotate user secret

Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.

Get Client Info

Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.

List active Trade Detection subscriptions

Adds or restores a Trade Detection subscription for a connected brokerage account.
This endpoint requires `userId` and `userSecret` in addition to the partner signature.


Add a Trade Detection subscription

Cancels a Trade Detection subscription for a connected brokerage account.
This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.


Cancel a Trade Detection subscription

**Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).

This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.

Returns a list of balances, positions, and recent orders for the specified account.

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
  - If you do, this endpoint returns real-time data.
  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.

Concurrent live holdings requests for the same account fail immediately with HTTP 409 and error code `1166`. Wait for the in-flight request to complete before retrying.


List account holdings

**Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, and line of credit accounts.

Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user.

This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).


List user accounts

Returns all accounts across all connections known to SnapTrade for the authenticated user.

The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.

This endpoint returns Daily data regardless of the customer's plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user's connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).


List all user accounts

**Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, and line of credit accounts.

Returns account detail known to SnapTrade for the specified account.

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
  - If you do, this endpoint returns real-time data.
  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


Get account detail

Updates various properties of a specified account.

Update details of an investment account

Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account.

On Pay as you Go / Real-time, this endpoint refreshes the account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.

On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.

If the connection has become disabled, it can no longer access the latest data from the institution, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


Get account details

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](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
  - If you do, this endpoint returns real-time data.
  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


List account balances

Returns a list of all positions in the specified account.

The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, CFD positions, and tokenized asset positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.

**Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change.

Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


List all account positions

Returns a list of recent orders in the specified account.

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
  - If you do, this endpoint returns real-time data.
  - If you don't, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


List account orders

Returns a list of recent orders in the specified account.

The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


List account orders v2

An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons)

The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values.


List historical account total value

A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders.
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 always realtime, and only checks the last 24 hours
By default only returns executed orders, but that can be changed by setting *only_executed* to false


List account recent orders (last 24 hours only)

A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
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.
**Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**


List account recent orders (V2, last 24 hours only)

DEPRECATED. Returns a list of rate of return percents for a given account.


List account rate of returns

This endpoint is not deprecated and has no planned sunset. Responses to requests using the legacy `/api/v1` path prefix include `Deprecation: @1781222400` (June 12, 2026); that header applies only to the path prefix. Use the canonical root path `/accounts/{accountId}/activities`.

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

This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.

If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.


List account activities

DEPRECATED. Returns a list of rate of return percents for a given connection.


List connection rate of returns

Returns a maximum of 10 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 is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys**

This endpoint does not work for options quotes.


Get equity symbol quotes

**Deprecated.** This endpoint was sunset on October 1, 2026 and now always returns `410 Gone`.

Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL  251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
**Note:** These are derived values and are not suitable for trading purposes.


Get option quote

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


Search account symbols

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


List all connections

Returns a single connection for the specified ID.

Get connection detail

Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.

Delete connection

Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) 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 an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
**Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless SnapTrade uses delayed data for the connection. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to `data_freshness_mode.snaptrade` on a connection to determine this.**


Refresh holdings for a connection

Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day's transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing


Sync transactions for a connection

Manually 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](/docs/webhooks#webhooks-connection_broken) 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.


Force disable connection

Returns all brokerage accounts that belong to the specified connection for the authenticated user.

On Pay as you Go / Real-time, this endpoint refreshes each account's opening date, funding date, and total value live from the brokerage on each call.

On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.


List accounts for a connection

Returns all accounts that belong to the specified connection for the authenticated user.

The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account.

On Pay as you Go / Real-time, this endpoint refreshes each account's opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts.

On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by institution. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).

Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.


List accounts

Returns a list of all defined Brokerage objects.

Get brokerages

Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.

A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.


List institutions

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

Get brokerage instruments

Returns a list of all defined Brokerage authorization Type objects.

Get all brokerage authorization types

Returns a list of all supported Exchanges.

Get exchanges

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


Search symbols

Returns 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](https://help.yahoo.com/kb/SLN2310.html)(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. Share classes and preferred series use SnapTrade's canonical dotted form: use `HBND.U.TO` (not Yahoo's `HBND-U.TO`), `FTN.PR.A.TO` (not `FTN-PA.TO`), and `ECF.PRA` (not `ECF-P-A`). Please use the ticker with the proper suffix and canonical share-class notation for the best results.


Get symbol detail

Places 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](/reference/Trading/Trading_getOrderImpact).

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](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.


Place equity order

**Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase.

Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages).

An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders.

All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces.

A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details.


Place a simple order (beta)

Places a complex conditional order (OCO, OTO, or OTOCO).
Only supported on certain brokerages.
Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support.

- **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled.
- **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order.
- **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.

Option OCO peers must trade the same OCC option symbol with the same closing
action and positive whole-contract quantity.

On tastytrade, option OCO supports closing an existing long or short option
position with one `Limit` order and one `Stop` or `StopLimit` order. Both
`PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with
`Day` or `GTC` time in force. Opening option OCOs are not supported.

On enabled Webull US v3 accounts, option OCO supports closing an existing long
option position with one `Limit` take-profit order and one `Stop` stop-loss order.
Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol,
and the same positive whole-contract quantity. Webull receives these as
`STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order.
Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs
are not supported on Webull. Equity complex-order behavior is unchanged.


Place complex order

Replaces 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


Replace order

Simulates 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](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.

Check equity order impact

Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder).

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](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.


Place checked equity order

Returns the detail of a single order using the external order ID provided in the request body.

This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future.

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.


Get account order detail

Returns the detail of a single order using the brokerage order ID provided as a path parameter.

The V2 order response format includes all legs of the order in the `legs` list field.
If the order is single legged, `legs` will be a list of one leg.

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.


Get account order detail (V2)

Places an order in the specified account.
This endpoint does not compute the impact to the account balance from the order before submitting the order.


Place crypto order

Cancels an order in the specified account. Accepts order IDs for all asset types.


Cancel order

Previews an order using the specified account.


Preview crypto order

Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.


Get crypto pairs

Get crypto pair quote

Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.


Get option order impact

Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support


Place option order

A webhook that is sent whenever a new connection is added.

/connectionAdded

A webhook that is sent whenever an existing connection is deleted.

/connectionDeleted

A webhook that is sent whenever a user is newly registered.

/userRegistered

A webhook that is sent whenever an existing user is deleted.

/userDeleted

A webhook that is sent whenever a new account is added to an existing brokerage authorization.

/accountAdded

A webhook that is sent whenever an existing account under a brokerage authorization is deleted.

/accountDeleted

A webhook that is sent whenever transactions have been updated for an account.

/transactionsUpdated

Notifies when account balance history has been updated for an account.

/accountBalanceHistoryUpdated

  Getting Started  This is an interactive demo to help you get started with the SnapTrade API  You can run the code snippets directly in your browser to see the API in action  By the end of this demo  you will have created a new user  connected a brokerage account  and retrieved account details and positions  Let s get started      1  Initialize a client with your clientId and consumerKey  You can get your SnapTrade  clientId  and  consumerKey  by  registering for a new account  https   dashboard snaptrade com signup   Once you have your credentials  please enter them below to initialize the SnapTrade client  Please note that your  consumerKey  is sensitive information and should be kept secure at all times       form    input name SNAPTRADE CLIENT ID label  Client ID  placeholder  YOUR CLIENT ID      input name SNAPTRADE CONSUMER KEY label  Consumer Key  placeholder  YOUR CONSUMER KEY  type  password       code     python import json from snaptrade client import SnapTrade  SnapTradeAuth import uuid import os  snaptrade   SnapTrade      auth SnapTradeAuth commercial api key          consumer key SNAPTRADE CONSUMER KEY          client id SNAPTRADE CLIENT ID            print  Successfully initiated client           typescript import   Snaptrade   from  snaptrade typescript sdk   const snaptrade   new Snaptrade     consumerKey  process env SNAPTRADE CONSUMER KEY    clientId  process env SNAPTRADE CLIENT ID      console log  Successfully initiated client             csharp Configuration configuration   new Configuration    string clientId   System Environment GetEnvironmentVariable  SNAPTRADE CLIENT ID    string consumerKey   System Environment GetEnvironmentVariable  SNAPTRADE CONSUMER KEY    configuration ApiKey Add  clientId   clientId   configuration ConsumerKey   consumerKey  apiStatusApi   new APIStatusApi configuration   authenticationApi   new AuthenticationApi configuration   accountInformationApi   new AccountInformationApi configuration   transactionsAndReportingApi   new TransactionsAndReportingApi configuration   referenceDataApi   new ReferenceDataApi configuration   optionsApi   new OptionsApi configuration   Console WriteLine  Successfully initiated clients                 button Initialize SDK Client            2  Create a new user on SnapTrade  To create a secure brokerage connection  we first need to register a SnapTrade user  Call the  a href  https   docs snaptrade com reference Authentication Authentication registerSnapTradeUser  target   blank  Register User  a  endpoint with a unique ID for an end user in your system  Upon success  you should receive a system 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      form    input name SNAPTRADE USER ID label  SnapTrade User ID  placeholder  YOUR SNAPTRADE USER ID       python user id   SNAPTRADE USER ID register response   snaptrade authentication register snap trade user  user id user id   print json dumps register response body  indent 2      Note  A user secret is only generated once  It s required to access   resources for certain endpoints   user secret   register response body  userSecret          button Register User           3  Connect a brokerage account  Now that the user is created  we are ready to connect their brokerage accounts to SnapTrade  This is done via the SnapTrade Connection Portal  Each Connection Portal session is unique to the user and is generated by calling the  a href  https   docs snaptrade com reference Authentication Authentication loginSnapTradeUser  target   blank  Generate Connection Portal URL  a  endpoint passing in the user ID and user secret      form     python redirect uri   snaptrade authentication login snap trade user  user id user id  user secret user secret    print json dumps redirect uri body  indent 2          button Generate Connection Portal URL        From the response  open the redirect URL in a new browser tab to complete the connection  and close it after you re done   If you don t have a live brokerage account to test with  you can create a Paper Trading account with  Alpaca  https   app alpaca markets signup  and select  Alpaca Paper  as the instituion in the Connection Portal when prompted       4  List connected accounts  Once the end user makes a successful connection  SnapTrade will retrieve all the brokerage accounts that the user has granted access to  You can use the  a href  https   docs snaptrade com reference Account 20Information AccountInformation listUserAccounts  target   blank  List Accounts  a  endpoint to retrieve all connected accounts  For each account  the  id  field uniquely identifies the account within SnapTrade and needs to be passed in for all subsequent account related API calls      form     python accounts   snaptrade account information list user accounts      user id user id      user secret user secret   print json dumps accounts body  indent 2    for account in accounts body      print    SAVE ACCOUNTS      format account  id            button List User Accounts           5  Get account detail  The  a href  https   docs snaptrade com reference Account 20Information AccountInformation getUserAccountDetails  target   blank  Account Detail  a  endpoint gives you a detailed view of the account  including account number  name  total market value  and more   Select a connected account below to retrieve the account detail      form skippable     enum name ACCOUNT ID label  Account ID  placeholder  ACCOUNT ID  savedData ACCOUNTS description  The SnapTrade account ID       python account id   ACCOUNT ID account detail   snaptrade account information get user account details      account id account id  user id user id  user secret user secret   print json dumps account detail body  indent 2          button Get Account Detail           6  Get account positions  The  a href  https   docs snaptrade com reference Account 20Information AccountInformation getAllAccountPositions  target   blank  Account Positions  a  endpoint gives you a list of all positions in the account  including stocks  ETFs  crypto  mutual funds  and option positions      form skippable      python positions   snaptrade account information get all account positions      account id account id  user id user id  user secret user secret   print json dumps positions body  indent 2          button Get Account Positions           7  Deleting a user  You ve reached the end of this demo  If you want to delete the user you created  you can do so by calling the  a href  https   docs snaptrade com reference Authentication Authentication deleteSnapTradeUser  target   blank  Delete User  a  endpoint  This will delete the user and all associated data  connections  accounts  positions  etc  permanently      form     python deleted response   snaptrade authentication delete snap trade user  user id user id   print json dumps deleted response body  indent 2          button Delete User       

Getting Started

consumer_key

PartnerSignature

PartnerTimestamp

SnapTrade

Connect your app to 450M+ retail investor accounts worldwide with SnapTrade's Brokerage Integrations. Learn more about our 40+ financial institution partnerships.