Get a custom view
Retrieve data for a custom view. A custom view combines views your account is entitled to into a single view with its own viewId.
Use GET /views to list the views available to your account, including custom views, and GET /views/{viewId} to see which datasets and data points a view returns.
get
Query Parameters
idTypestring
Specifies the type of the value passed in the id parameter.
Morningstar Performance ID is the default identifer for the API. Use the Universe API to retrieve Performance IDs for investments in your entitled universe.
Allowed values:performanceIdisinsecurityIdcusiptradingSymbolfundCodemsid
Default:performanceId
baseCurrencystring
Base currency to use for investment lookup. Accepts 3‑character ISO 4217 currency codes.
domicilestring
Domicile to use for investment lookup. Accepts 3-character ISO 3166-1 country codes.
exchangeCountrystring
Exchange country to use for investment lookup. Accepts 3-character ISO 3166-1 country codes.
exchangeIdstring
Exchange identifier to use for investment lookup.
Path Parameters
idstringrequired
Specifies the investment to query.
Morningstar Performance ID is the default identifer for the API. Use the Universe API to retrieve Performance IDs for investments in your entitled universe.
Example:0P00000046
viewIdstringrequired
Identifier of the custom view, as returned by GET /views.
Response
application/json
Response
application/json
OK
ResponseCustomView
Contains one property per view or dataset included in the custom view, named as in the response of that view (for example activeShare), alongside identifiers and metadata.
identifiersobject
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/{id}/{viewId}
Authentication
Path Parameters
Query Parameters
application/json
Utility Endpoints
Retrieve a view definition
get
Path Parameters
viewIdstringrequired
A view id, a standard package/dataset id, or the id of a saved dataset. When omitted, returns all entitled views and saved datasets.
Response
application/json
Response
application/json
OK
ResponseGetView
Response containing a view definition and the datapoints included in the view.
* Additional properties are NOT allowed.
viewDefinitionobjectrequired
Definition of a view, including the datapoints it contains.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/views/{viewId}
Authentication
Path Parameters
application/json
List views
Retrieve the list of data views your account is entitled to access, along with the corresponding viewId values required to request investment details.
get
Response
application/json
Response
application/json
OK
ResponseListViews
Response containing entitled view packages and their associated dataset viewIds.
* Additional properties are NOT allowed.
viewsarray[object]required
A view package and the dataset viewIds it contains.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/views
Authentication
application/json
ResponseCustomView
objectContains one property per view or dataset included in the custom view, named as in the response of that view (for example activeShare), alongside identifiers and metadata.
identifiersobject
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject
All fields are nullable. Empty or null value fields are not returned.
* Additional properties are NOT allowed.
Show Child Parameters
Example