Morningstar
App · 25 actions
Search securities and retrieve Morningstar investment, household, portfolio and risk model data.
Actions
| Action | What it does |
|---|---|
| Get a category forecast for a flow model | Get a category forecast for a flow model |
| Get all risk models | Get all risk models |
| Get annuity benefits | Get benefits data for variable annuity subaccounts |
| Get category forecasts for a flow model | Get category forecasts for a flow model |
| Get client profile | Get client profile |
| Get closure probability forecast for a fund | Get closure probability forecast for a fund |
| Get exposures for a share class | Get exposures for a share class |
| Get flow model factors | Get flow model factors |
| Get flow models | Get flow models |
| Get growth forecast for a share class | Get growth forecast for a share class |
| Get household profiles | Get household profiles |
| Get household's member list | Get household's member list |
| Get Institution Client profile | Get Institution Client profile |
| Get member profile | Get member profile |
| Get portfolio holdings | Get holdings for a portfolio |
| Get portfolio profiles | Get household accounts |
| Get premia data for a flow model | Get premia data for a flow model |
| Get risk exposures for investment(s) | Get risk exposures for investment(s) |
| Get risk model factors | Get risk model factors |
| Get securities | Get securities data |
| List households | Get household IDs |
| Query securities | Create securities data |
| Query securities screener | Create security and associated data points |
| Screen securities | Get securites and associated data points |
| Search securities | Get securities |
Get a category forecast for a flow model
Get a category forecast for a flow model
Inputs
- Accumulated
accumulatedtext - Return accumulated dataOne of:
true,false. - Category ID
category_idtextRequired - Unique identifier of a category
- Flow model ID
flow_model_idtextRequired - Unique identifier of a flow modelOne of:
usa-univariate-category-fundflow.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get all risk models
Get all risk models
Inputs
- Is new
is_newtrue/false - Return recently created onlyOne of:
true,false. - Investment IDS
investment_idstext - Unique Morningstar identifier for securities. Multiple values must be comma-separated.
- Edition
editiontext - Internal use only
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get annuity benefits
Get benefits data for variable annuity subaccounts
Inputs
- SecIds
secIdstextRequired - Unique identifier of a security. Multiple entries must be pipe-separated '|'.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"assetAllocationType": "example",
"currencyId": "example",
"customBenchmark": "example",
"dataPoints": "example",
"languageId": "example",
"secIds": "example",
"universeIds": "example"
},
"has_more": false,
"next_cursor": null
}Get category forecasts for a flow model
Get category forecasts for a flow model
Inputs
- Period
periodtext - Number of months in time period
- Accumulated
accumulatedtext - Return accumulated dataOne of:
true,false. - Flow model ID
flow_model_idtextRequired - Unique identifier of a flow modelOne of:
usa-univariate-category-fundflow.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get client profile
Get client profile
Inputs
- HouseholdId
householdIdtextRequired - Unique identifier of a household
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"address1": "example",
"address2": "example",
"address3": "example",
"city": "example",
"clientName": "example",
"dateOfBirth": "2026-10-01",
"desiredRetirementAge": "example",
"email": "example",
"firstName": "example",
"homePhone": "example",
"householdId": "example",
"lastName": "example",
"reviewDate": "2026-10-01",
"socialSecurityNumber": "example",
"state": "example",
"status": "example",
"workPhone": "example",
"zipCode": "example"
},
"has_more": false,
"next_cursor": null
}Get closure probability forecast for a fund
Get closure probability forecast for a fund
Inputs
- Fund IDS
fund_idstextRequired - Unique identifier of a fund
- Flow model ID
flow_model_idtextRequired - Unique identifier of a flow modelOne of:
usa-equity-shareclass-fundflow,canada-equity-shareclass-fundflow,europe-equity-shareclass-fundflow,global-equity-shareclass-fundflow,usa-allocation-shareclass-fundflow,canada-allocation-shareclass-fundflow,europe-allocation-shareclass-fundflow,global-allocation-shareclass-fundflow,usa-fixedincome-shareclass-fundflow,canada-fixedincome-shareclass-fundflow, and 3 more.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get exposures for a share class
Get exposures for a share class
Inputs
- Frequency
frequencytext - Frequency to base results onOne of:
monthly,quarterly,annually. - Share class IDS
share_class_idstextRequired - Unique identifier of a share class
- End
enddate - End date of time period
- Start
startdate - Start date of time period
- Flow model ID
flow_model_idtextRequired - Unique identifier of a flow modelOne of:
usa-equity-shareclass-fundflow,canada-equity-shareclass-fundflow,europe-equity-shareclass-fundflow,global-equity-shareclass-fundflow,usa-allocation-shareclass-fundflow,canada-allocation-shareclass-fundflow,europe-allocation-shareclass-fundflow,global-allocation-shareclass-fundflow,usa-fixedincome-shareclass-fundflow,canada-fixedincome-shareclass-fundflow, and 3 more.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get flow model factors
Get flow model factors
Inputs
- Flow model ID
flow_model_idtextRequired - Unique identifier of a flow model
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get flow models
Get flow models
Inputs
None.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get growth forecast for a share class
Get growth forecast for a share class
Inputs
- Share class IDS
share_class_idstextRequired - Unique identifier of a share class
- Flow model ID
flow_model_idtextRequired - Unique identifier of a flow modelOne of:
usa-equity-shareclass-fundflow,canada-equity-shareclass-fundflow,europe-equity-shareclass-fundflow,global-equity-shareclass-fundflow,usa-allocation-shareclass-fundflow,canada-allocation-shareclass-fundflow,europe-allocation-shareclass-fundflow,global-allocation-shareclass-fundflow,usa-fixedincome-shareclass-fundflow,canada-fixedincome-shareclass-fundflow, and 3 more.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get household profiles
Get household profiles
Inputs
- Limit
limitnumber - Limit number of records returned. Default is 100 or 500.At least 1.
- Skip
skipnumber - Number of results to skipAt least 0.
- Count
counttrue/false - Return the total count of profiles. Default is `false`.One of:
true,false.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"_meta": {
"hint": "example",
"response_status": "example"
},
"households": [
{
"active": false,
"clientType": {
"code": 1,
"name": "example"
},
"householdId": "example",
"householdType": "client",
"name": "example",
"ownerId": "example",
"ownerName": "example",
"permission": {
"code": 1,
"name": "example"
},
"views": {}
}
],
"pagination": {
"count": 1,
"limit": 1,
"skip": 1
}
},
"has_more": false,
"next_cursor": null
}Get household's member list
Get household's member list
Inputs
- HouseholdId
householdIdtextRequired - Unique identifier of a household
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"members": [
{
"address1": "example",
"address2": "example",
"address3": "example",
"city": "example",
"email": "example",
"firstName": "example",
"lastName": "example",
"memberId": "example",
"name": "example",
"relationshipId": "example",
"relationshipName": "example",
"state": "example",
"zipCode": "example"
}
]
},
"has_more": false,
"next_cursor": null
}Get Institution Client profile
Get Institution Client profile
Inputs
- HouseholdId
householdIdtextRequired - Unique identifier of a household
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"primaryContact": {
"cellPhone": "example",
"dateOfBirth": "2026-10-01",
"email": "example",
"firstName": "example",
"lastName": "example",
"role": "example",
"socialSecurityNumber": "example",
"title": "example",
"workPhone": "example"
},
"profile": {
"address1": "example",
"address2": "example",
"address3": "example",
"city": "example",
"dateOfIncorporation": "2026-10-01",
"fax": "example",
"incorporationState": "example",
"institutionId": "example",
"institutionName": "example",
"institutionType": "example",
"isUSCorporation": "example",
"phone": "example",
"state": "example",
"taxIdType": "example",
"zipCode": "example"
}
},
"has_more": false,
"next_cursor": null
}Get member profile
Get member profile
Inputs
- HouseholdId
householdIdtextRequired - Unique identifier of a household
- MemberId
memberIdnumberRequired - Unique identifier of a member
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"address1": "example",
"address2": "example",
"address3": "example",
"city": "example",
"dateOfBirth": "2026-10-01",
"desiredRetirementAge": "example",
"email": "example",
"firstName": "example",
"homePhone": "example",
"householdId": "example",
"lastName": "example",
"memberId": "example",
"relationshipId": "example",
"socialSecurityNumber": "example",
"state": "example",
"status": "example",
"workPhone": "example",
"zipCode": "example"
},
"has_more": false,
"next_cursor": null
}Get portfolio holdings
Get holdings for a portfolio
Inputs
- PortfolioIds
portfolioIdslistRequired - Unique identifier of a portfolio. Multiple values must be comma-separated.
- Enddate
enddatedate - Return results with end date specified (yyyy-mm-dd, yyyymmdd or LastMonthEnd).
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"_meta": {
"hint": "example",
"response_status": "example"
},
"errMsg": "example",
"portfolios": [
{
"accountTypeName": "example",
"householdId": "example",
"lastUpdateTime": "example",
"name": "example",
"number": "example",
"portfolioId": "example",
"portfolioType": "example",
"portfolioTypeName": "example",
"snapshots": [
{
"date": "example",
"topNHoldingsCount": 1
}
],
"topHoldingList": {
"additionalProperties": {
"top-holdings": [
{}
],
"total": "example",
"validation-end-date": "example"
}
},
"trackingMethod": "positional"
}
]
},
"has_more": false,
"next_cursor": null
}Get portfolio profiles
Get household accounts
Inputs
- HouseholdIds
householdIdslistRequired - Unique identifier of a household. Multiple values must be comma-separated.
- Limit
limitnumber - Limit number of records returned. Default is 100 or 500.At least 1.
- Skip
skipnumber - Number of results to skipAt least 0.
- Count
counttrue/false - Return the total count of profiles when "limit" or "skip" parameter is used. Default is `false`.One of:
true,false.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"_meta": {
"hint": "example",
"response_status": "example"
},
"pagination": {
"count": 1,
"limit": 1,
"skip": 1
},
"portfolios": [
{
"currency": "example",
"custodianId": "example",
"custodianName": "example",
"excludeInClientAggregate": false,
"householdId": "example",
"householdName": "example",
"isDynamicAggregate": false,
"lastUpdateTime": "example",
"name": "example",
"number": "example",
"ownerId": "example",
"ownerName": "example",
"permission": "example",
"portfolioId": "example",
"portfolioType": "example",
"portfolioTypeName": "example",
"trackingMethod": "positional",
"unmanagedAsset": false,
"views": {}
}
]
},
"has_more": false,
"next_cursor": null
}Get premia data for a flow model
Get premia data for a flow model
Inputs
- Frequency
frequencytext - Frequency to base results onOne of:
monthly,quarterly,annually. - Accumulated
accumulatedtext - Return accumulated dataOne of:
true,false. - End
enddate - End date of time period
- Start
startdate - Start date of time period
- Flow model ID
flow_model_idtextRequired - Unique identifier of a flow modelOne of:
usa-equity-shareclass-fundflow,canada-equity-shareclass-fundflow,europe-equity-shareclass-fundflow,global-equity-shareclass-fundflow,usa-allocation-shareclass-fundflow,canada-allocation-shareclass-fundflow,europe-allocation-shareclass-fundflow,global-allocation-shareclass-fundflow,usa-fixedincome-shareclass-fundflow,canada-fixedincome-shareclass-fundflow, and 3 more.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get risk exposures for investment(s)
Get risk exposures for investment(s)
Inputs
- Risk model ID
risk_model_idtextRequired - Unique identifier of a risk model
- Investment IDS
investment_idstextRequired - Unique Morningstar identifier for securities. Multiple values must be comma-separated.
- Start
startdate - Start date of time period. If start date and end date are not defined, most recent data will be returned.
- End
enddate - End date of time period. If start date and end date are not defined, most recent data will be returned.
- Frequency
frequencytext - Frequency the response will be based onOne of:
day_end,month_start,month_end,quarter_start,quarter_end.
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get risk model factors
Get risk model factors
Inputs
- Risk model ID
risk_model_idtextRequired - Unique identifer of a risk model
Outputs
Value.
dataobject- JSON returned by this endpoint; the official specification does not define its fields.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get securities
Get securities data
Inputs
- SecIds
secIdstextRequired - Unique identifier of a security. Multiple entries must be pipe-separated '|'.
- UniverseIds
universeIdstext - Unique five-letter identifier created by combining a two-letter Investment Type code and three-letter country code. Multiple entries must be pipe-separated '|'.
- LangCult
langCulttext - Language and locale, for example, en-US
- DataPoints
dataPointstext - Unique identifier of a data point. Can be data point ID or short ID.
- CurrencyId
currencyIdtext - ISO 4217 currency code, for example 'USD'
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"assetAllocationType": "example",
"currencyId": "example",
"customBenchmark": "example",
"dataPoints": "example",
"languageId": "example",
"secIds": "example",
"universeIds": "example"
},
"has_more": false,
"next_cursor": null
}List households
Get household IDs
Inputs
None.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"_meta": {
"hint": "example",
"response_status": "example"
},
"householdIds": [
{
"householdType": "example",
"id": "example",
"name": "example"
}
]
},
"has_more": false,
"next_cursor": null
}Query securities
Create securities data
Inputs
- SecIds
secIdstextRequired - Unique identifier of a security. Multiple entries must be pipe-separated '|'.
- UniverseIds
universeIdstext - Unique five-letter identifier created by combining a two-letter Investment Type code and three-letter country code. Multiple entries must be pipe-separated '|'.
- LangCult
langCulttext - Language and locale, for example, en-US
- DataPoints
dataPointstext - Unique identifier of a data point. Can be data point ID or short ID.
- CurrencyId
currencyIdtext - ISO 4217 currency code, for example, 'USD'
- Request dataPoints
request_dataPointstext - Datapoints.
- SecurityIds
securityIdstext - Securityids.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"assetAllocationType": "example",
"currencyId": "example",
"customBenchmark": "example",
"dataPoints": "example",
"languageId": "example",
"secIds": "example",
"universeIds": "example"
},
"has_more": false,
"next_cursor": null
}Query securities screener
Create security and associated data points
Inputs
- SecurityDataPoints
securityDataPointstext - Unique identifier of a data point. Can be data point ID or short ID. Multiple values must be pipe-separated.
- Request securityDataPoints
request_securityDataPointstext - Securitydatapoints.
- Filters
filterstext - Filters.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Screen securities
Get securites and associated data points
Inputs
- StartIndex
startIndextext - Row to start query from. Zero-based index; first row is '0.'
- SecurityType
securityTypetext - Unique identifier of a security type
- Results
resultstext - Maximum number of rows to return
- Sort
sorttext - Sort by data point
- Dir
dirtext - Sort results in ascending/descending directionOne of:
asc,desc. - Output
outputtext - Format of the returned contentOne of:
json. - Langcult
langculttext - Language and locale, for example, en-US
- Universe
universetext - Unique identifier of a universe
- SecurityDataPoints
securityDataPointstext - Unique identifier of a data point. Can be data point ID or short ID. Multiple values must be pipe-separated.
- Filters
filterstext - Data point ID with either min/max values, or a list of specific values. Multiple criteria must be comma-separated.
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"assetAllocationType": "example",
"currencyId": "example",
"customBenchmark": "example",
"dataPoints": "example",
"languageId": "example",
"secIds": "example",
"universeIds": "example"
},
"has_more": false,
"next_cursor": null
}Search securities
Get securities
Inputs
- Query
querytext - Text string to search for
- Universes
universestext - Unique five-letter identifier created by combining a two-letter Investment Type code and three-letter country code. Multiple entries must be pipe-separated '|'.
- SecurityDataPoints
securityDataPointstext - Data points to return in response. Multiple values must be pipe-separated. Valid values are data point ID or short ID.
- Results
resultstext - Number of rows to limit results to
- ResponseSchema
responseSchematext - Response Schema config in SBT
- Schema
schematext - Schema config in SBT
- FilterCriteria
filterCriteriatext - Filter express to filter the defined securities in the information retrieved
- Langcult
langculttext - Language and locale, for example, en-US
- Currency
currencytext - ISO 4217 currency code, for example, 'USD'
Outputs
Value.
dataobject- The API response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value, or empty at the end.
Example output
{
"data": {
"currency": "example",
"filterCriteria": "example",
"langcult": "example",
"query": "example",
"responseSchema": "example",
"schema": "example",
"securityDataPoints": "example",
"universes": "example"
},
"has_more": false,
"next_cursor": null
}