Account Information

Update details of an investment account

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

Updates various properties of a specified account.

Execute an API Request

Path
accountIdstring (format: uuid)required

The ID of the account to update.

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
$
npm install snaptrade-typescript-sdk
1
Loading...

Response fields

array of objects
object

A single account at a brokerage.

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_name": "Robinhood",
8
"created_date": "2024-07-23T22:50:22.761Z",
9
"sync_status": {
10
"transactions": {
11
"initial_sync_completed": true,
12
"last_successful_sync": "2022-01-24",
13
"first_transaction_date": "2022-01-24"
14
},
15
"holdings": {
16
"initial_sync_completed": true,
17
"last_successful_sync": "2024-06-28 18:42:46.561408+00:00"
18
}
19
},
20
"balance": {
21
"total": {
22
"amount": 15363.23,
23
"currency": "USD"
24
}
25
},
26
"status": "open",
27
"raw_type": "Margin",
28
"meta": {
29
"type": "Margin",
30
"status": "ACTIVE",
31
"institution_name": "Robinhood"
32
},
33
"portfolio_group": "2bcd7cc3-e922-4976-bce1-9858296801c3",
34
"cash_restrictions": []
35
}
36
]