Investment Details Feed API
Get detailed profile data for up to 250 investments in a single request, drawing on Morningstar's fundamental, reference, and historical data..
API Inputs
Request-Level Inputs
These inputs apply to the request as a whole: the Prefer header, and the top-level fields of the request body, including the list of investments to query and the list of views to retrieve. They control which investments are returned and how results are filtered, independent of which views are requested.
baseCurrency
| Attribute | Value |
|---|---|
| Type | Request Payload (investments[]) |
| Data Type | string |
| Possible Values | 3-character ISO 4217 currency codes |
| Example | USD |
Specifies base currency used to look up investment. Accepts 3-character ISO 4217 currency codes.
For more information about investment lookup, see the Identifiers page.
countryId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes. Default: USA |
| Example | CAN |
Specifies the country to filter results on. Accepts 3-character ISO 3166-1 country codes. Required for country-dependent data.
domicile
| Attribute | Value |
|---|---|
| Type | Request Payload (investments[]) |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes |
| Example | USA |
Specifies domicile used to look up investment. Accepts 3-character ISO 3166-1 country codes.
For more information about investment lookup, see the Identifiers page.
endDate
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string (date) |
| Possible Values | yyyy-MM-dd |
| Example | 2024-01-25 |
Specifies the end date of a time series.
exchangeCountry
| Attribute | Value |
|---|---|
| Type | Request Payload (investments[]) |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes |
| Example | USA |
Specifies exchange country used to look up investment. Accepts 3-character ISO 3166-1 country codes.
For more information about investment lookup, see the Identifiers page.
exchangeId
| Attribute | Value |
|---|---|
| Type | Request Payload (investments[]) |
| Data Type | string |
| Possible Values | — |
| Example | EX$$$$XNAS |
Specifies exchange identifier used to look up investment.
For more information about investment lookup, see the Identifiers page.
id
| Attribute | Value |
|---|---|
| Type | Request Payload (investments[]) |
| Data Type | string |
| Possible Values | A performance ID, ISIN, security ID, CUSIP, trading symbol, or Morningstar ID, matching the idType provided |
| Example | 0P00000046 |
Specifies the investment identifier to query. Required for each investment.
idType
| Attribute | Value |
|---|---|
| Type | Request Payload (investments[]) |
| Data Type | string |
| Possible Values | performanceId, isin, fundCode, securityId, cusip, msid, tradingSymbol, industryCode. Default: performanceId |
| Example | performanceId |
Specifies the type of identifier provided in id.
investments
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of objects |
| Possible Values | 1 to 250 items |
| Example | [{ "id": "0P00000046", "idType": "performanceId" }] |
List of investments to query. Required. A maximum of 250 investments can be passed in a single request.
languageId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | ENG, SPA, FRA, DEU, ITA, JPN, CHI, ZHO, KOR. Default: ENG |
| Example | ENG |
Specifies the language to filter results on. Required for language-dependent data.
Prefer
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | respond-async |
| Example | respond-async |
Must be set to respond-async to indicate the request should be processed asynchronously. Required. If omitted or set to another value, the server responds with an error message.
regionId
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string |
| Possible Values | 1 (United States), 2 (Canada), 3 (Latin America), 4 (Europe), 5 (Japan), 6 (Australia/New Zealand), 7 (Asia excluding Japan) |
| Example | 1 |
Specifies the region for style box breakpoints.
startDate
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | string (date) |
| Possible Values | yyyy-MM-dd |
| Example | 2020-01-25 |
Specifies the start date of a time series.
views
| Attribute | Value |
|---|---|
| Type | Request Payload |
| Data Type | array of objects |
| Possible Values | 1 to 3 items |
| Example | [{ "viewId": "equity-basic-details" }] |
List of views to retrieve. Required. A maximum of 3 views can be requested per call must be requested alone. See View-Level Inputs below for the fields inside each entry.
View-Level Inputs
These inputs live inside each object in the views array. viewId selects the view; parameters holds any additional fields that view requires, and its shape depends on the viewId selected. Most views take no parameters at all — the fields below only apply to the views noted in each description.
parameters
| Attribute | Value |
|---|---|
| Type | Request Payload (views[]) |
| Data Type | object |
| Possible Values | Varies by viewId — see the individual parameter fields on this page |
| Example | { "reportType": "a", "period": "q1" } |
Container for the additional fields a view requires. Required for parameterized views; omitted for views that take no parameters.
viewId
| Attribute | Value |
|---|---|
| Type | Request Payload (views[]) |
| Data Type | string |
| Possible Values | Any entitled view identifier`. |
| Examples | equity-basic-details, 0009976GH |
Required. Identifies which view to retrieve for the requested investments. Determines whether a parameters object is required or supported.
viewType
| Attribute | Value |
|---|---|
| Type | Request Payload (views[]) |
| Data Type | string |
| Possible Values | package, dataset, ddaDataset |
| Example | equity-basic-details |
Required. Identifies which view to retrieve for the requested investments. Determines whether a parameters object is required or supported.