How do I generate a holdings report?

Prev Next

You can generate a holdings report for a transaction portfolio at any time.

Using the LUSID web app

  1. Navigate to the Portfolio Management > Holdings dashboard.

  2. Choose a portfolio or portfolio group and optionally an effective date (defaults to today):

Using Luminesce

You can use the Lusid.Portfolio.Holding provider.

Using the LUSID REST API

Call the LUSID GetHoldings API. Note you can decorate instrument as well as holdings properties onto the response using the propertyKeys parameter, and it's almost always useful to retrieve the Instrument/default/Name system property in order to meaningfully identify results. Note also the request is effective today unless you specify a historical date using the effectiveAt parameter. For example:

curl -X GET "https://<your-domain>.lusid.com/api/api/transactionportfolios/Finbourne-Examples/UK-Equities/holdings?propertyKeys=Instrument%2Fdefault%2FName"
   -H "Authorization: Bearer <your-API-access-token>"

If the request is successful, the response contains one value per holding, for example:

"values": [
    {
      "instrumentScope": "default",
      "instrumentUid": "LUID_WPFIPFGD",
      "subHoldingKeys": {},
      "properties": {
        "Instrument/default/Name": {
          "key": "Instrument/default/Name",
          "value": {
            "labelValue": "LEGAL&GEN."
          },
          "effectiveFrom": "0001-01-01T00:00:00.0000000+00:00"
        },
        "Holding/default/SourcePortfolioId": {
          "key": "Holding/default/SourcePortfolioId",
          "value": {
            "labelValue": "UK-Equities"
          },
          "effectiveFrom": "0001-01-01T00:00:00.0000000+00:00"
        },
        "Holding/default/SourcePortfolioScope": {
          "key": "Holding/default/SourcePortfolioScope",
          "value": {
            "labelValue": "Finbourne-Examples"
          },
          "effectiveFrom": "0001-01-01T00:00:00.0000000+00:00"
        }
      },
      "holdingType": "P",
      "units": 82867.64705882352,
      "settledUnits": 82867.64705882352,
      "cost": {
        "amount": 238244.49,
        "currency": "GBP"
      },
      "costPortfolioCcy": {
        "amount": 238244.49,
        "currency": "GBP"
      },
      "currency": "GBP"
    },
    ...
]