Get transaction history for a user / SnapTrade

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

clientId

consumerKey

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
Loading...

Response fields

array of objects

object

A transaction or activity from an institution

idstring

accountobject

SnapTradeUser Investment Account

amountnumber or null

currencyobject

Currency

descriptionstring

feenumber

fx_ratenumber or null

The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency)

institutionstring

option_typestring

If an option transaction, then it's type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string

pricenumber

settlement_datestring

external_reference_idstring or null

Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same external_reference_id

symbolobject

Symbol

option_symbolobject

Options Symbol

trade_datestring or null

typestring

Potential values include (but are not limited to) - 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

unitsnumber

Usually but not necessarily an integer

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

Made with Konfig