logo
Book A Demo
Book A Demo
Account Information

Get account detail

get
https://api.snaptrade.com/api/v1/accounts/{accountId}

Returns account detail known to SnapTrade for the specified account.

The data returned here is always cached and refreshed once a day. If you need real-time data, please use the manual refresh 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 on how to fix a disabled connection.

Execute an API Request

Path
accountIdstring (format: uuid)required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

Query
userIdstringrequired

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

userSecretstringrequired

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Authorization
Request
Installation
GitHubnpm
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

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

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

metaobject

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)

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

cash_restrictionsarray of strings

This field is deprecated.

1
{
2
  "id": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
3
  "brokerage_authorization": "87b24961-b51e-4db8-9226-f198f6518a89",
4
  "name": "Robinhood Individual",
5
  "number": "Q6542138443",
6
  "institution_name": "Robinhood",
7
  "created_date": "2024-07-23T22:50:22.761Z",
8
  "sync_status": {
9
    "transactions": {
10
      "initial_sync_completed": true,
11
      "last_successful_sync": "2022-01-24",
12
      "first_transaction_date": "2022-01-24"
13
    },
14
    "holdings": {
15
      "initial_sync_completed": true,
16
      "last_successful_sync": "2024-06-28 18:42:46.561408+00:00"
17
    }
18
  },
19
  "balance": {
20
    "total": {
21
      "amount": 15363.23,
22
      "currency": "USD"
23
    }
24
  },
25
  "status": "open",
26
  "raw_type": "Margin",
27
  "meta": {
28
    "type": "Margin",
29
    "status": "ACTIVE",
30
    "institution_name": "Robinhood"
31
  },
32
  "portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",
33
  "cash_restrictions": []
34
}
Made with Konfig