List accounts / SnapTrade

List accounts

get

https://api.snaptrade.com/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. Customers on Pay as you Go / Daily can force a refresh with the manual refresh endpoint.

Execute an API Request

Authentication Method

Use commercial authentication when acting on behalf of your application and passing end-user credentials with requests that require them.

Credentials

clientId

consumerKey

userId

userSecret

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
import {
2
  Snaptrade,
3
  SnaptradeAuth,
4
} from "snaptrade-typescript-sdk";
5

6
const snaptrade = new Snaptrade({
7
  auth: SnaptradeAuth.commercialApiKey({
8
    consumerKey: "CONSUMER_KEY",
9
    clientId: "CLIENT_ID",
10
  }),
11
});
12

13
const response =
14
  await snaptrade.accountInformation.listUserAccounts(
15
    {
16
      userId: "USER_ID",
17
      userSecret: "USER_SECRET",
18
    },
19
  );
20
console.log(response.data);

Response fields

array of objects

List of brokerage accounts across all connections.

object

A single account at a brokerage.

idstring (format: uuid)

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.

brokerage_authorizationstring (format: uuid)

Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.

namestring or null

A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.

numberstring

The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.

institution_account_idstring or null

A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.

institution_namestring

The name of the brokerage that holds the account.

created_datestring (format: date-time)

Timestamp in ISO 8601 format indicating when the account was created in SnapTrade. This is not the account opening date at the brokerage.

funding_datestring (format: date-time) or null

Timestamp in ISO 8601 format indicating when the account was funded.

opening_datestring (format: date-time) or null

Timestamp in ISO 8601 format indicating when the account was opened at the brokerage.

sync_statusobject

Contains status update for the account sync process between SnapTrade and the brokerage.

balanceobject

Contains balance related information for the account.

statusstring or null

The current status of the account. Can be either "open", "closed", "archived" or null if the status is unknown or not provided by the brokerage.

raw_typestring or null

The account type as provided by the brokerage

account_categorystring or null

The category of the account, normalized across institutions. Returns null if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See Filtering Accounts by Category for more information.

INVESTMENT: A brokerage / investment account (equities, options, crypto, etc.).
DEPOSIT: A bank deposit account (checking, savings).
LOC: A line of credit account.

metaobject

Deprecated

Refrain from usage of this field

Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there's no standard format for this data. This field is deprecated and subject to removal in a future version.

portfolio_groupstring (format: uuid) or null

Deprecated

Refrain from usage of this field

Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.

cash_restrictionsarray of strings

Deprecated

Refrain from usage of this field

This field is deprecated.

is_paperboolean

Indicates whether the account is a paper (simulated) trading account.

1
[
2
  {
3
    "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
4
    "brokerage_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",
5
    "name": "Robinhood Individual",
6
    "number": "Q6542138443",
7
    "institution_account_id": "54953432",
8
    "institution_name": "Robinhood",
9
    "created_date": "2024-07-23T22:50:22.761Z",
10
    "funding_date": "2024-07-25T12:00:00.000Z",
11
    "opening_date": "2024-07-20T09:30:00.000Z",
12
    "sync_status": {
13
      "transactions": {
14
        "initial_sync_completed": true,
15
        "last_successful_sync": "2022-01-24T00:00:00.000Z",
16
        "first_transaction_date": "2022-01-24T00:00:00.000Z"
17
      },
18
      "holdings": {
19
        "initial_sync_completed": true,
20
        "last_successful_sync": "2024-06-28T18:42:46.561Z"
21
      }
22
    },
23
    "balance": {
24
      "total": {
25
        "amount": 15363.23,
26
        "currency": "USD"
27
      }
28
    },
29
    "status": "open",
30
    "raw_type": "Margin",
31
    "account_category": "INVESTMENT",
32
    "meta": {
33
      "type": "Margin",
34
      "status": "ACTIVE",
35
      "institution_name": "Robinhood"
36
    },
37
    "portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",
38
    "cash_restrictions": [],
39
    "is_paper": false
40
  }
41
]

Made with Konfig