logo
Transactions And Reporting

Get transaction history for a user

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

Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance

Execute an API Request

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)

startDatestring (format: date)

Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)

endDatestring (format: date)

Date used to specify timeframe for a reporting call (in YYYY-MM-DD format)

accountsstring

Optional comma seperated list of account IDs used to filter the request on specific accounts

brokerageAuthorizationsstring

Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations

typestring

Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT

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

Response fields

array of objects
object

A transaction or activity from an institution

1
[
2
{
3
"id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",
4
"account": {
5
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
6
"name": "Registered Retirement Savings Account",
7
"number": "Q6542138443",
8
"sync_status": {
9
"transactions": {
10
"initial_sync_completed": true,
11
"last_successful_sync": "2022-01-24"
12
}
13
}
14
},
15
"amount": 263.82,
16
"currency": {
17
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
18
"code": "USD",
19
"name": "US Dollar"
20
},
21
"description": "WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22",
22
"fee": 0,
23
"fx_rate": 1.032,
24
"institution": "SnapTrade Investr",
25
"option_type": "BUY_TO_OPEN",
26
"price": 0.4,
27
"settlement_date": "2022-01-06T05:00:00.000Z",
28
"external_reference_id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",
29
"symbol": {
30
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
31
"symbol": "VAB.TO",
32
"raw_symbol": "VAB",
33
"name": "Vanguard Canadian Aggregate Bond Index ETF",
34
"currency": {
35
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
36
"code": "USD",
37
"name": "US Dollar"
38
},
39
"exchange": {
40
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
41
"code": "TSX",
42
"mic_code": "XTSE",
43
"name": "Toronto Stock Exchange",
44
"timezone": "America/New_York",
45
"start_time": "09:30:00",
46
"close_time": "16:00:00",
47
"suffix": ".TO"
48
},
49
"type": {
50
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
51
"code": "cs",
52
"description": "Common Stock",
53
"is_supported": true
54
},
55
"figi_code": "BBG000B9XRY4",
56
"figi_instrument": {
57
"figi_code": "BBG000B9Y5X2",
58
"figi_share_class": "BBG001S5N8V8"
59
}
60
},
61
"option_symbol": {
62
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
63
"ticker": "SPY 220819P00200000",
64
"option_type": "CALL",
65
"strike_price": 200,
66
"expiration_date": "2017-07-17T15:13:07.177712+00:00",
67
"is_mini_option": false,
68
"underlying_symbol": {
69
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
70
"symbol": "SPY",
71
"description": "SPDR S&P 500 ETF Trust",
72
"currency": {
73
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
74
"code": "USD",
75
"name": "US Dollar"
76
},
77
"exchange": {
78
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
79
"code": "ARCX",
80
"mic_code": "ARCA",
81
"name": "NYSE ARCA",
82
"timezone": "America/New_York",
83
"start_time": "09:30:00",
84
"close_time": "16:00:00",
85
"suffix": "None",
86
"allows_cryptocurrency_symbols": false
87
},
88
"type": {
89
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
90
"code": "cs",
91
"description": "Common Stock",
92
"is_supported": true
93
},
94
"currencies": [
95
{
96
"id": "87b24961-b51e-4db8-9226-f198f6518a89",
97
"code": "USD",
98
"name": "US Dollar"
99
}
100
],
101
"figi_code": "BBG000B9XRY4",
102
"figi_instrument": {
103
"figi_code": "BBG000B9Y5X2",
104
"figi_share_class": "BBG001S5N8V8"
105
}
106
},
107
"local_id": "40817960",
108
"exchange_id": "6e73ee7b-fdf3-44c2-947d-260c3ee72506"
109
},
110
"trade_date": "2022-01-06T05:00:00.000Z",
111
"type": "string",
112
"units": 5
113
}
114
]