Account Information

List account rate of returns

Returns a list of rate of return percents for a given account.

get/accounts/{accountId}/returnRates

Path parameters

accountIdstring uuid required

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

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631

Query parameters

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
timeframesstring
Example:ALL,1Y

Optional comma separated list of rate-of-return timeframes to return. Supported values are ALL, 1Y, YTD, 1M, 1W, and 1D. If omitted, SnapTrade returns all six supported timeframes.

Response

OK

Example response

{
  "data": [
    {
      "timeframe": "ALL",
      "return_percent": 5.97,
      "created_date": "2024-07-30T22:51:49.746270Z"
    }
  ]
}

Changes

Changed in 4 of the 65 revisions of this API.69

    • added the non-success response with the status 501

      response-non-success-status-added

    • added the non-success response with the status 503

      response-non-success-status-added

  • 38856e7dc61033See the full diff
    • added the new 1D enum value to the data/items/timeframe response property for the response status 200

      response-property-enum-value-added

    • added the new 1W enum value to the data/items/timeframe response property for the response status 200

      response-property-enum-value-added

    • added the new YTD enum value to the data/items/timeframe response property for the response status 200

      response-property-enum-value-added

    • added the new optional query request parameter timeframes

      new-optional-request-parameter

    • removed the 3M enum value from the data/items/timeframe response property for the response status 200

      response-property-enum-value-removed

    • removed the 6M enum value from the data/items/timeframe response property for the response status 200

      response-property-enum-value-removed

    • deleted the query request parameter timeframes

      request-parameter-removed

    • added the new 3M enum value to the data/items/timeframe response property for the response status 200

      response-property-enum-value-added

    • added the new 6M enum value to the data/items/timeframe response property for the response status 200

      response-property-enum-value-added

    • removed the non-success response with the status 503

      response-non-success-status-removed

    • removed the 1D enum value from the data/items/timeframe response property for the response status 200

      response-property-enum-value-removed

    • removed the 1W enum value from the data/items/timeframe response property for the response status 200

      response-property-enum-value-removed

    • removed the YTD enum value from the data/items/timeframe response property for the response status 200

      response-property-enum-value-removed

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog