API Reference
GET
/api/platform/v1/accounts/{accountId}/holdings

Returns investment holdings for the specified brokerage account. Only available for providers that support holdings (SnapTrade, MX, Finicity, Pluggy).

Authorization

BearerAuth
AuthorizationBearer <token>

Data and portal endpoints: use the access_token returned by POST /users or POST /oauth/token.

In: header

Path Parameters

accountId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/platform/v1/accounts/string/holdings"
{
  "holdings": [
    {
      "security": {
        "name": "string",
        "currency": "string",
        "tickerSymbol": "string",
        "figi": "string",
        "cusp": "string",
        "isin": "string"
      },
      "quantity": 0,
      "price": 0,
      "value": 0,
      "costBasis": 0,
      "currency": "string",
      "raw": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "totalValue": 0,
  "currency": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}