List account rate of returns
Returns a list of rate of return percents for a given account.
Path parameters
Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
Query parameters
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.
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.
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
501response-non-success-status-added
- ○
- ○
added the non-success response with the status
503response-non-success-status-added
- ○
- ●
added the new
1Denum value to thedata/items/timeframeresponse property for the response status200response-property-enum-value-added
- ●
added the new
1Wenum value to thedata/items/timeframeresponse property for the response status200response-property-enum-value-added
- ●
added the new
YTDenum value to thedata/items/timeframeresponse property for the response status200response-property-enum-value-added
- ○
added the new optional
queryrequest parametertimeframesnew-optional-request-parameter
- ○
removed the
3Menum value from thedata/items/timeframeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
6Menum value from thedata/items/timeframeresponse property for the response status200response-property-enum-value-removed
- ●
- ●
deleted the
queryrequest parametertimeframesrequest-parameter-removed
- ●
added the new
3Menum value to thedata/items/timeframeresponse property for the response status200response-property-enum-value-added
- ●
added the new
6Menum value to thedata/items/timeframeresponse property for the response status200response-property-enum-value-added
- ○
removed the non-success response with the status
503response-non-success-status-removed
- ○
removed the
1Denum value from thedata/items/timeframeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
1Wenum value from thedata/items/timeframeresponse property for the response status200response-property-enum-value-removed
- ○
removed the
YTDenum value from thedata/items/timeframeresponse property for the response status200response-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
- ●