Get Holding Summary

Endpoint: GET /derived/holdingSummary

The get holding summary service is used to get the summary of asset classifications for the user.

By default, accounts with status as ACTIVE and TO BE CLOSED will be considered.

If the include parameter value is passed as details then a summary with holdings and account information is returned.

Parameters

For the Request

Example Request

curl -X GET /derived/holdingSummary \\
	-H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}"

Example Response

{
  "holdingSummary": [
    {
      "holding": [
        {
          "symbol": "string",
          "exercisedQuantity": 0,
          "cusipNumber": "string",
          "assetClassification": {
            "allocation": 0,
            "classificationType": "string",
            "classificationValue": "string"
          },
          "vestedQuantity": 0,
          "description": "string",
          "unvestedValue": {
            "amount": 0,
            "currency": "AUD"
          },
          "securityStyle": "string",
          "vestedValue": {
            "amount": 0,
            "currency": "AUD"
          },
          "optionType": "put",
          "lastUpdated": "string",
          "matchStatus": "string",
          "holdingType": "stock",
          "maturityDate": "string",
          "price": {
            "amount": 0,
            "currency": "AUD"
          },
          "term": "string",
          "contractQuantity": 0,
          "id": 0,
          "isShort": true,
          "value": {
            "amount": 0,
            "currency": "AUD"
          },
          "expirationDate": "string",
          "interestRate": 0,
          "quantity": 0,
          "accruedInterest": {
            "amount": 0,
            "currency": "AUD"
          },
          "grantDate": "string",
          "sedol": "string",
          "vestedSharesExercisable": 0,
          "spread": {
            "amount": 0,
            "currency": "AUD"
          },
          "accountId": 0,
          "enrichedDescription": "string",
          "couponRate": 0,
          "createdDate": "string",
          "accruedIncome": {
            "amount": 0,
            "currency": "AUD"
          },
          "securityType": "string",
          "providerAccountId": 0,
          "unvestedQuantity": 0,
          "costBasis": {
            "amount": 0,
            "currency": "AUD"
          },
          "vestingDate": "string",
          "isin": "string",
          "strikePrice": {
            "amount": 0,
            "currency": "AUD"
          }
        }
      ],
      "classificationType": "string",
      "classificationValue": "string",
      "value": {
        "amount": 0,
        "currency": "AUD"
      },
      "account": [
        {
          "id": 0,
          "value": {
            "amount": 0,
            "currency": "AUD"
          }
        }
      ]
    }
  ],
  "link": {
    "holdings": "string"
  }
}

Get Transaction Summary

Endpoint: GET /derived/transactionSummary

The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.Notes:

1. Details can be requested for only one system-defined category
2. Passing categoryType is mandatory except when the groupBy value is CATEGORY_TYPE