Get performance information for a specific timeframe / SnapTrade

Get performance information for a specific timeframe

get

https://api.snaptrade.com/api/v1/performance/custom

Deprecated

Refrain from usage of this operation

Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.

Execute an API Request

Query

startDatestring (format: date)required

Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.

endDatestring (format: date)required

Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.

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.

accountsstring

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

detailedboolean

Optional, increases frequency of data points for the total value and contribution charts if set to true

Unset

False

True

frequencystring

Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.

Authorization

clientId

consumerKey

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
Loading...

Response fields

object

Performance Custom Response Object

totalEquityTimeframearray of objects

contributionsobject

contributionTimeframearray of objects

contributionTimeframeCumulativearray of objects

withdrawalTimeframearray of objects

contributionStreaknumber or null

Current streak of cosecutive months where contributions were made

contributionMonthsContributednumber or null

Number of months in the timeframe with contributions

contributionTotalMonthsnumber or null

Total months in timeframe

dividendsarray of objects

dividendIncomenumber or null

Total dividends received over the timeframe

monthlyDividendsnumber or null

Average dividends received per month over the timeframe

badTickersarray of strings

list of tickers which may not be supported or may not have accurate price data

dividendTimelinearray of objects

commissionsnumber or null

commissions incurred during the timeframe

forexFeesnumber or null

forex fees incurred during the timeframe

feesnumber or null

other fees incurred during the timeframe

rateOfReturnnumber or null

The return rate over the timeframe. Annualized if timeframe is longer than 1 year

returnRateTimeframearray of objects

detailedModeboolean

Whether the user has detailed mode enabled (more frequent data points for totalEquity and contribution timeframes)

1
{
2
  "totalEquityTimeframe": [
3
    {
4
      "date": "2022-01-24",
5
      "value": 52.74,
6
      "currency": "CAD"
7
    }
8
  ],
9
  "contributions": {
10
    "date": "2022-01-24",
11
    "contributions": 524.74,
12
    "currency": "CAD"
13
  },
14
  "contributionTimeframe": [
15
    {
16
      "date": "2022-01-24",
17
      "value": 52.74,
18
      "currency": "CAD"
19
    }
20
  ],
21
  "contributionTimeframeCumulative": [
22
    {
23
      "date": "2022-01-24",
24
      "value": 52.74,
25
      "currency": "CAD"
26
    }
27
  ],
28
  "withdrawalTimeframe": [
29
    {
30
      "date": "2022-01-24",
31
      "value": 52.74,
32
      "currency": "CAD"
33
    }
34
  ],
35
  "contributionStreak": 5,
36
  "contributionMonthsContributed": 10,
37
  "contributionTotalMonths": 13,
38
  "dividends": [
39
    {
40
      "symbol": {
41
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
42
        "symbol": "VAB.TO",
43
        "raw_symbol": "VAB",
44
        "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
45
        "currency": {
46
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
47
          "code": "USD",
48
          "name": "US Dollar"
49
        },
50
        "exchange": {
51
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
52
          "code": "TSX",
53
          "mic_code": "XTSE",
54
          "name": "Toronto Stock Exchange",
55
          "timezone": "America/New_York",
56
          "start_time": "09:30:00",
57
          "close_time": "16:00:00",
58
          "suffix": ".TO"
59
        },
60
        "type": {
61
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
62
          "code": "cs",
63
          "description": "Common Stock",
64
          "is_supported": true
65
        },
66
        "figi_code": "BBG000B9XRY4",
67
        "figi_instrument": {
68
          "figi_code": "BBG000B9Y5X2",
69
          "figi_share_class": "BBG001S5N8V8"
70
        },
71
        "currencies": [
72
          {
73
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
74
            "code": "USD",
75
            "name": "US Dollar"
76
          }
77
        ]
78
      },
79
      "amount": 165.05,
80
      "currency": "USD"
81
    }
82
  ],
83
  "dividendIncome": 135.97,
84
  "monthlyDividends": 26.37,
85
  "badTickers": [
86
    "MAW105"
87
  ],
88
  "dividendTimeline": [
89
    {
90
      "date": "2022-01-24",
91
      "dividends": [
92
        {
93
          "symbol": "AAPL",
94
          "amount": 6.82,
95
          "currency": "CAD"
96
        }
97
      ]
98
    }
99
  ],
100
  "commissions": 3.26,
101
  "forexFees": 5.26,
102
  "fees": 2.72,
103
  "rateOfReturn": 0.082312367452,
104
  "returnRateTimeframe": [
105
    {
106
      "periodStart": "2022-01-24",
107
      "periodEnd": "2022-01-24",
108
      "rateOfReturn": 0.012312367452
109
    }
110
  ],
111
  "detailedMode": true
112
}

Made with Konfig