logo
Account Information

List account positions

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

Returns a list of positions in the specified account.

Execute an API Request

Path
accountIdstring (format: uuid)required

The ID of the account to get positions.

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

Account Position

1
[
2
{
3
"symbol": {
4
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
5
"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
6
"symbol": {
7
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
8
"symbol": "VAB.TO",
9
"raw_symbol": "VAB",
10
"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
11
"currency": {
12
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
13
"code": "USD",
14
"name": "US Dollar"
15
},
16
"exchange": {
17
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
18
"code": "TSX",
19
"mic_code": "XTSE",
20
"name": "Toronto Stock Exchange",
21
"timezone": "America/New_York",
22
"start_time": "09:30:00",
23
"close_time": "16:00:00",
24
"suffix": ".TO"
25
},
26
"type": {
27
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
28
"code": "cs",
29
"description": "Common Stock",
30
"is_supported": true
31
},
32
"currencies": [
33
{
34
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
35
"code": "USD",
36
"name": "US Dollar"
37
}
38
],
39
"figi_code": "BBG000B9XRY4",
40
"figi_instrument": {
41
"figi_code": "BBG000B9Y5X2",
42
"figi_share_class": "BBG001S5N8V8"
43
}
44
},
45
"local_id": "3291231",
46
"is_quotable": true,
47
"is_tradable": true
48
},
49
"units": 40,
50
"price": 113.15,
51
"open_pnl": 0.44,
52
"fractional_units": 1.44,
53
"average_purchase_price": 108.3353
54
}
55
]