v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0175184292.5 KB

Transactions And Reporting

Get performance information for a specific timeframe

Deprecated. 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.

get/performance/custom

Query parameters

startDatestring date required

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

Example:2022-01-24

endDatestring date required

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

Example:2022-01-24

accountsstring

Comma separated list of account IDs

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2

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

detailedboolean

Example:true

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

frequencystring

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

Example:monthly

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

userIdstring required

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.

Example:snaptrade-user-123

userSecretstring required

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.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Response

Successfully retrieved performance data

contributionStreaknumber nullable

Current streak of consecutive months where contributions were made

contributionMonthsContributednumber nullable

Number of months in the timeframe with contributions

contributionTotalMonthsnumber nullable

Total months in timeframe

dividendIncomenumber nullable

Total dividends received over the timeframe

monthlyDividendsnumber nullable

Average dividends received per month over the timeframe

badTickersstring[]

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

commissionsnumber nullable

commissions incurred during the timeframe

forexFeesnumber nullable

forex fees incurred during the timeframe

feesnumber nullable

other fees incurred during the timeframe

rateOfReturnnumber nullable

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

detailedModeboolean

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

Example response

{
  "totalEquityTimeframe": [
    {
      "date": "2022-01-24",
      "value": 52.74,
      "currency": "CAD"
    }
  ],
  "contributions": {
    "date": "2022-01-24",
    "contributions": 524.74,
    "currency": "CAD"
  },
  "contributionTimeframe": [
    {
      "date": "2022-01-24",
      "value": 52.74,
      "currency": "CAD"
    }
  ],
  "contributionTimeframeCumulative": [
    {
      "date": "2022-01-24",
      "value": 52.74,
      "currency": "CAD"
    }
  ],
  "withdrawalTimeframe": [
    {
      "date": "2022-01-24",
      "value": 52.74,
      "currency": "CAD"
    }
  ],
  "contributionStreak": 5,
  "contributionMonthsContributed": 10,
  "contributionTotalMonths": 13,
  "dividends": [
    {
      "symbol": {
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
        "symbol": "VAB.TO",
        "raw_symbol": "VAB",
        "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
        "currency": {
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
          "code": "USD",
          "name": "US Dollar"
        },
        "exchange": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "code": "TSX",
          "mic_code": "XTSE",
          "name": "Toronto Stock Exchange",
          "timezone": "America/New_York",
          "start_time": "09:30:00",
          "close_time": "16:00:00",
          "suffix": ".TO"
        },
        "type": {
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
          "code": "cs",
          "description": "Common Stock",
          "is_supported": true
        },
        "figi_code": "BBG000B9XRY4",
        "figi_instrument": {
          "figi_code": "BBG000B9Y5X2",
          "figi_share_class": "BBG001S5N8V8"
        },
        "currencies": [
          {
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
            "code": "USD",
            "name": "US Dollar"
          }
        ]
      },
      "amount": 165.05,
      "currency": "USD"
    }
  ],
  "dividendIncome": 135.97,
  "monthlyDividends": 26.37,
  "badTickers": [
    "MAW105"
  ],
  "dividendTimeline": [
    {
      "date": "2022-01-24",
      "dividends": [
        {
          "symbol": "AAPL",
          "amount": 6.82,
          "currency": "CAD"
        }
      ]
    }
  ],
  "commissions": 3.26,
  "forexFees": 5.26,
  "fees": 2.72,
  "rateOfReturn": 0.082312367452,
  "returnRateTimeframe": [
    {
      "periodStart": "2022-01-24",
      "periodEnd": "2022-01-24",
      "rateOfReturn": 0.012312367452
    }
  ]
}