How do I generate a holdings report?

Providing you are a LUSID user with sufficient privileges, you can request LUSID to generate a holdings report for a transaction portfolio.

Note: If you are the LUSID domain owner, you are automatically assigned the built-in lusid-administrator role, which has all the permissions necessary to perform the operations in this article.

• Method 1: Using the LUSID REST API
• Method 2: Using the LUSID web app

Note: If you have a Luminesce license, you can generate a holdings report by writing a SQL query.

Using the LUSID REST API

1. Obtain an API access token.
2. 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"
       },
       ...
   ]

Using the LUSID web app

1. Sign in to the LUSID web app using the credentials of a LUSID administrator.
2. From the top left menu, select Dashboard > Holdings:
   
3. On the Holdings dashboard, choose a Portfolio (highlighted in red) and optionally an Effective date (defaults to today):