logo
Account Information

List accounts

get
https://api.snaptrade.com/api/v1/accounts

Get a list of all Account objects for the authenticated SnapTrade user.

Execute an API Request

Query
userIdstringrequired

SnapTrade User ID

userSecretstringrequired

SnapTrade User Secret (generated when registering user)

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

Response fields

array of objects
object

SnapTradeUser Investment Account

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