Get Holdings

Endpoint: GET /holdings

The get holdings service is used to get the list of holdings of a user.

Supported holding types can be employeeStockOption, moneyMarketFund, bond, etc. and is obtained using get holding type list service.

Asset classifications for the holdings need to be requested through the "include" parameter.

Asset classification information for holdings are not available by default, as it is a premium feature.

Parameters

For the Request

Example Request

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

Example Response

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

Get Holding Type List

Endpoint: GET /holdings/holdingTypeList

The get holding types list service is used to get the supported holding types.

The response includes different holding types such as future, moneyMarketFund, stock, etc. and it returns the supported holding types