How do I create a reference portfolio?

Providing you have suitable access control permissions, you can create a reference portfolio to model an index in LUSID.

Note: Once created, you can only change certain characteristics of a reference portfolio in some circumstances. More information.

To create a reference portfolio, you must specify a unique identifier and friendly name. You can optionally:

  • Nominate a base (or reporting) currency. This must be in the form of an ISO 4217 currency code, for example GBP or JPY.

  • Specify a creation date prior to today (the default). This is important if you intend to load historical constituents.

  • Register an instrument scope in order to resolve constituents to instruments mastered in that scope, before falling back to the default instrument scope.

  • Add custom properties to store additional information about the portfolio not recorded by the standard set of data fields. These properties must be from the Portfolio domain.

To examine the complete set of data fields for a reference portfolio, examine the API documentation. Note that to subsequently interact you can use the APIs in the Portfolios collection as well as the Reference Portfolios collection.

There are several ways to create a reference portfolio:

Using the LUSID REST API

  1. Obtain an API access token.

  2. Call the LUSID CreateReferencePortfolio API for your LUSID domain, passing in your API access token, nominating a scope in the URL, and specifying in the request body:

    • A displayName.

    • A code unique to the scope.

    For example, to create a GBP-denominated portfolio with a creation date at the start of 2022 in myexamplescope (this is created if it does not exist):

    curl -X POST "https://<your-domain>.lusid.com/api/api/referenceportfolios/myexamplescope"
  -H "Authorization: Bearer <your-API-access-token>"
  -H "Content-Type: application/json"
  -d '{
    "displayName": "Example reference portfolio",
    "code": "Index",
    "created": "2022-01-01T00:00:00Z",
    "baseCurrency": "GBP"
  }'

    Providing the request is successful, the response lists the values applied to optional data fields. Note the identifier for the portfolio entity consists of the scope and code:

    {
    "id": {
        "scope": "myexamplescope",
        "code": "Index"
    },
    "type": "Reference",
    "displayName": "Example reference portfolio",
    "created": "2022-01-01T00:00:00.0000000+00:00",
    "version": {
        "effectiveFrom": "2022-01-01T00:00:00.0000000+00:00",
        "asAtDate": "2022-10-07T11:31:51.3585380+00:00"
    },
    "isDerived": false,
    "baseCurrency": "GBP",
    "instrumentScopes": [],
    "accountingMethod": "Default",
    "amortisationMethod": "NoAmortisation",
}

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 Data Management > Portfolios.

  3. Click the Create Portfolio button (top right).

  4. On the Basic data screen of the Create Portfolio dialog, choose Reference from the Type dropdown menu, and specify a Scope, Code and Effective date:
     

  5. Complete the other optional fields if desired and click the Create button on the Property constraints screen.