Investment List API
Build the Investment List API into your digital experience for quick investment and earnings summaries.
API Inputs
Request-Level Inputs
These inputs apply to the request as a whole: the request headers, and the top-level fields of the request body, including the investments to retrieve, the data points to return, and the sort and language and currency settings. The investments and sort fields contain objects, whose inputs are described in Investment Inputs and Sort Inputs.
accept
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | application/json |
| Example | application/json |
Specifies the response format.
Authorization
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | Bearer {token}, where the token is a JSON Web Token |
| Example | Bearer eyJhbGciOi... |
Specifies the token that authorizes the request. Required. For more information about getting a token, see the Authentication page.
Content-Type
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | application/json |
| Example | application/json |
Specifies the format of the request body. Required for POST requests.
currencyId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | — |
| Example | USD |
Optional. Currency for the investment list results.
dataPoints
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of strings |
| Possible Values | Data point names in dataGroup.fieldName format. A maximum of 50 values can be passed. |
| Example | ["basicReference.isin", "companyInformation.legalName", "balanceSheet.totalAssetsValueFY"] |
Required. Lists the data points to return for each investment. Each value is the data group and the field name, separated by a period. The performance ID is always returned.
Retrieve valid values programmatically with GET /direct-web-services/v1/investment-list/data-points, or browse the full reference in the data dictionary (Excel).
investments
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of objects |
| Possible Values | Investment objects. A maximum of 100 investments can be passed. See Investment Inputs. |
| Example | [{"id": "0P00000046"}, {"id": "US0042391096", "idType": "isin"}] |
Required. List of investments to query. Each object identifies one investment and can include the lookup inputs described under Investment Inputs.
languageId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | — |
| Example | ENG |
Optional. Language for the investment list results.
sort
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of objects |
| Possible Values | Sort objects. A maximum of 2 can be passed. See Sort Inputs. Default: ascending performanceId |
| Example | [{"dataPoint": "companyInformation.companyId", "orderBy": "asc"}, {"dataPoint": "dailyReturnsMostRecent.totalRet1DayDaily", "orderBy": "desc"}] |
Optional. Fields to sort the results by. If omitted, results are sorted by performanceId in ascending order. Pass up to two sort objects to override the default.
Investment Inputs
These inputs are passed in each object of the investments array. They identify the investment to look up and apply lookup filters.
For more information about investment lookup, see the Identifiers page.
baseCurrency
| Attribute | Value |
|---|---|
| Type | Request Payload (investments) |
| Data Type | string |
| Possible Values | 3-character ISO 4217 currency codes |
| Example | USD |
Optional. Base currency to use for investment lookup. Accepts 3-character ISO 4217 currency codes.
domicile
| Attribute | Value |
|---|---|
| Type | Request Payload (investments) |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes |
| Example | USA |
Optional. Domicile to use for investment lookup. Accepts 3-character ISO 3166-1 country codes.
exchangeCountry
| Attribute | Value |
|---|---|
| Type | Request Payload (investments) |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes |
| Example | USA |
Optional. Exchange country to use for investment lookup. Accepts 3-character ISO 3166-1 country codes.
exchangeId
| Attribute | Value |
|---|---|
| Type | Request Payload (investments) |
| Data Type | string |
| Possible Values | See the list of exchange IDs |
| Example | EX$$$$XNAS |
Optional. Exchange identifier to use for investment lookup.
id
| Attribute | Value |
|---|---|
| Type | Request Payload (investments) |
| Data Type | string |
| Possible Values | A performance ID, ISIN, fund code, security ID, CUSIP, trading symbol, or Morningstar ID, matching the idType provided |
| Example | 0P00000046 |
Required. Specifies the investment to query. Must contain at least one character. Morningstar Performance ID is the default identifier; use the Universe API to retrieve Performance IDs for investments in your entitled universe.
idType
| Attribute | Value |
|---|---|
| Type | Request Payload (investments) |
| Data Type | string |
| Possible Values | performanceId, isin, fundCode, securityId, cusip, msid, tradingSymbol. Default: performanceId |
| Example | isin |
Optional. Specifies the type of identifier provided in id.
Sort Inputs
These inputs are passed in each object of the sort array.
dataPoint
| Attribute | Value |
|---|---|
| Type | Request Payload (sort) |
| Data Type | string |
| Possible Values | A data point in dataPoints, in dataGroup.fieldName format. Default: instrumentIdentifiers.performanceId |
| Example | dailyReturnsMostRecent.totalRet1DayDaily |
The data point to sort by. It must also be in the dataPoints array, so use the same names that it accepts.
orderBy
| Attribute | Value |
|---|---|
| Type | Request Payload (sort) |
| Data Type | string |
| Possible Values | asc (ascending), desc (descending). Default: asc |
| Example | desc |
The sort direction for dataPoint.