List account activities / SnapTrade

List account activities

get

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

Returns all historical transactions for the specified account.

This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.

Transaction are returned in reverse chronological order, using the trade_date field.

The data returned here is always cached and refreshed once a day.

Execute an API Request

Path

accountIdstring (format: uuid)required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

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.

startDatestring (format: date)

The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on trade_date.

endDatestring (format: date)

The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on trade_date.

offsetinteger (format: int32)

An integer that specifies the starting point of the paginated results. Default is 0.

limitinteger (format: int32)

An integer that specifies the maximum number of transactions to return. Default of 1000.

typestring

Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values:

BUY - Asset bought.
SELL - Asset sold.
DIVIDEND - Dividend payout.
CONTRIBUTION - Cash contribution.
WITHDRAWAL - Cash withdrawal.
REI - Dividend reinvestment.
STOCK_DIVIDEND - A type of dividend where a company distributes shares instead of cash
INTEREST - Interest deposited into the account.
FEE - Fee withdrawn from the account.
OPTIONEXPIRATION - Option expiration event.
OPTIONASSIGNMENT - Option assignment event.
OPTIONEXERCISE - Option exercise event.
TRANSFER - Transfer of assets from one account to another

Authorization

clientId

consumerKey

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
Loading...

Response fields

object

A paginated list of UniversalActivity objects.

dataarray of objects

idstring

Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.

Please note that this ID can change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.

symbolobject or null

The security for the transaction. The field is null if the transaction is not related to a security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's symbol. In cases where the brokerage symbol is not recognized, the field will be set to null.

option_symbolobject or null

The option security for the transaction. The field is null if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage's option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to null.

pricenumber

The price of the security for the transaction. This is mostly applicable to BUY, SELL, and DIVIDEND transactions.

unitsnumber

The number of units of the security for the transaction. This is mostly applicable to BUY, SELL, and DIVIDEND transactions.

amountnumber or null

The amount of the transaction denominated in currency. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount.

currencyobject

The currency in which the transaction price and amount is denominated.

typestring

A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values:

BUY - Asset bought.
SELL - Asset sold.
DIVIDEND - Dividend payout.
CONTRIBUTION - Cash contribution.
WITHDRAWAL - Cash withdrawal.
REI - Dividend reinvestment.
INTEREST - Interest deposited into the account.
FEE - Fee withdrawn from the account.
OPTIONEXPIRATION - Option expiration event. option_symbol contains the related option contract info.
OPTIONASSIGNMENT - Option assignment event. option_symbol contains the related option contract info.
OPTIONEXERCISE - Option exercise event. option_symbol contains the related option contract info.

option_typestring

If an option BUY or SELL transaction, this further specifies the type of action. The possible values are:

BUY_TO_OPEN
BUY_TO_CLOSE
SELL_TO_OPEN
SELL_TO_CLOSE

descriptionstring

A human-readable description of the transaction. This is usually the brokerage's description of the transaction.

trade_datestring (format: date-time) or null

The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the integrations page for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named trade_date, it can represent any type of transaction, not just trades.

settlement_datestring (format: date-time)

The date on which the transaction is settled.

feenumber

Any fee associated with the transaction if provided by the brokerage.

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

The institution that the transaction is associated with. This is usually the brokerage name.

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

paginationobject

Details about the pagination of the results.

1
{
2
  "data": [
3
    {
4
      "id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6",
5
      "symbol": {
6
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
7
        "symbol": "VAB.TO",
8
        "raw_symbol": "VAB",
9
        "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
10
        "currency": {
11
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
12
          "code": "USD",
13
          "name": "US Dollar"
14
        },
15
        "exchange": {
16
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
17
          "code": "TSX",
18
          "mic_code": "XTSE",
19
          "name": "Toronto Stock Exchange",
20
          "timezone": "America/New_York",
21
          "start_time": "09:30:00",
22
          "close_time": "16:00:00",
23
          "suffix": ".TO"
24
        },
25
        "type": {
26
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
27
          "code": "cs",
28
          "description": "Common Stock",
29
          "is_supported": true
30
        },
31
        "figi_code": "BBG000B9XRY4",
32
        "figi_instrument": {
33
          "figi_code": "BBG000B9Y5X2",
34
          "figi_share_class": "BBG001S5N8V8"
35
        }
36
      },
37
      "option_symbol": {
38
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
39
        "ticker": "AAPL  261218C00240000",
40
        "option_type": "CALL",
41
        "strike_price": 240,
42
        "expiration_date": "2026-12-18",
43
        "is_mini_option": false,
44
        "underlying_symbol": {
45
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
46
          "symbol": "SPY",
47
          "raw_symbol": "VAB",
48
          "description": "SPDR S&P 500 ETF Trust",
49
          "currency": {
50
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
51
            "code": "USD",
52
            "name": "US Dollar"
53
          },
54
          "exchange": {
55
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
56
            "code": "ARCX",
57
            "mic_code": "ARCA",
58
            "name": "NYSE ARCA",
59
            "timezone": "America/New_York",
60
            "start_time": "09:30:00",
61
            "close_time": "16:00:00",
62
            "suffix": "None",
63
            "allows_cryptocurrency_symbols": false
64
          },
65
          "type": {
66
            "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
67
            "code": "cs",
68
            "description": "Common Stock",
69
            "is_supported": true
70
          },
71
          "figi_code": "BBG000B9XRY4",
72
          "figi_instrument": {
73
            "figi_code": "BBG000B9Y5X2",
74
            "figi_share_class": "BBG001S5N8V8"
75
          },
76
          "currencies": [
77
            {
78
              "id": "87b24961-b51e-4db8-9226-f198f6518a89",
79
              "code": "USD",
80
              "name": "US Dollar"
81
            }
82
          ]
83
        }
84
      },
85
      "price": 0.4,
86
      "units": 5.2,
87
      "amount": 263.82,
88
      "currency": {
89
        "id": "87b24961-b51e-4db8-9226-f198f6518a89",
90
        "code": "USD",
91
        "name": "US Dollar"
92
      },
93
      "type": "BUY",
94
      "option_type": "BUY_TO_OPEN",
95
      "description": "WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22",
96
      "trade_date": "2024-03-22T16:27:55.000Z",
97
      "settlement_date": "2024-03-26T00:00:00.000Z",
98
      "fee": 0,
99
      "fx_rate": 1.032,
100
      "institution": "Robinhood",
101
      "external_reference_id": "2f7dc9b3-5c33-4668-3440-2b31e056ebe6"
102
    }
103
  ],
104
  "pagination": {
105
    "offset": 0,
106
    "limit": 100
107
  }
108
}

Made with Konfig