logo
Account Information

Return details of a specific investment account

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

Returns an account object with details for the specified account, including the total account market value.

Execute an API Request

Path
accountIdstring (format: uuid)required

The ID of the account to get detail of.

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 (generated when registering user)

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

Response fields

object

SnapTradeUser Investment Account

idstring (format: uuid)
brokerage_authorizationstring (format: uuid)
portfolio_groupstring (format: uuid)
namestring
numberstring
institution_namestring
created_datestring
metaobject
cash_restrictionsarray of objects
sync_statusobject

Status of account

balanceobject

Balance of the account

1
{
2
  "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
3
  "brokerage_authorization": "2bcd7cc3-e922-4976-bce1-9858296801c3",
4
  "portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",
5
  "name": "Registered Retirement Savings Account",
6
  "number": "Q6542138443",
7
  "institution_name": "Alpaca",
8
  "created_date": "2021-06-04T16:26:46.523Z",
9
  "meta": {
10
    "type": "Margin",
11
    "status": "ACTIVE",
12
    "institution_name": "Alpaca"
13
  },
14
  "cash_restrictions": [
15
    {
16
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
17
      "account": "2bcd7cc3-e922-4976-bce1-9858296801c3",
18
      "currency": "2bcd7cc3-e922-4976-bce1-9858296801c3",
19
      "type": "ALLOCATE_MAX",
20
      "amount": 100
21
    }
22
  ],
23
  "sync_status": {
24
    "transactions": {
25
      "initial_sync_completed": true,
26
      "last_successful_sync": "2022-01-24",
27
      "first_transaction_date": "2022-01-24"
28
    },
29
    "holdings": {
30
      "initial_sync_completed": true,
31
      "last_successful_sync": "2024-06-28 18:42:46.561408+00:00"
32
    }
33
  },
34
  "balance": {
35
    "total": null
36
  }
37
}
Made with Konfig