Sign in

v51

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

List connection rate of returns

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

get/authorizations/{authorizationId}/returnRates

Path parameters

authorizationIdstring uuid required

Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.

Example:87b24961-b51e-4db8-9226-f198f6518a89

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"
    }
  ]
}