Morningstar

App · 25 actions

Search securities and retrieve Morningstar investment, household, portfolio and risk model data.

Actions

ActionWhat it does
Get a category forecast for a flow modelGet a category forecast for a flow model
Get all risk modelsGet all risk models
Get annuity benefitsGet benefits data for variable annuity subaccounts
Get category forecasts for a flow modelGet category forecasts for a flow model
Get client profileGet client profile
Get closure probability forecast for a fundGet closure probability forecast for a fund
Get exposures for a share classGet exposures for a share class
Get flow model factorsGet flow model factors
Get flow modelsGet flow models
Get growth forecast for a share classGet growth forecast for a share class
Get household profilesGet household profiles
Get household's member listGet household's member list
Get Institution Client profileGet Institution Client profile
Get member profileGet member profile
Get portfolio holdingsGet holdings for a portfolio
Get portfolio profilesGet household accounts
Get premia data for a flow modelGet premia data for a flow model
Get risk exposures for investment(s)Get risk exposures for investment(s)
Get risk model factorsGet risk model factors
Get securitiesGet securities data
List householdsGet household IDs
Query securitiesCreate securities data
Query securities screenerCreate security and associated data points
Screen securitiesGet securites and associated data points
Search securitiesGet securities

Get a category forecast for a flow model

Get a category forecast for a flow model

Inputs

Accumulatedaccumulatedtext
Return accumulated dataOne of: true, false.
Category IDcategory_idtextRequired
Unique identifier of a category
Flow model IDflow_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 newis_newtrue/false
Return recently created onlyOne of: true, false.
Investment IDSinvestment_idstext
Unique Morningstar identifier for securities. Multiple values must be comma-separated.
Editioneditiontext
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

SecIdssecIdstextRequired
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

Periodperiodtext
Number of months in time period
Accumulatedaccumulatedtext
Return accumulated dataOne of: true, false.
Flow model IDflow_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

HouseholdIdhouseholdIdtextRequired
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 IDSfund_idstextRequired
Unique identifier of a fund
Flow model IDflow_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

Frequencyfrequencytext
Frequency to base results onOne of: monthly, quarterly, annually.
Share class IDSshare_class_idstextRequired
Unique identifier of a share class
Endenddate
End date of time period
Startstartdate
Start date of time period
Flow model IDflow_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 IDflow_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 IDSshare_class_idstextRequired
Unique identifier of a share class
Flow model IDflow_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

Limitlimitnumber
Limit number of records returned. Default is 100 or 500.At least 1.
Skipskipnumber
Number of results to skipAt least 0.
Countcounttrue/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

HouseholdIdhouseholdIdtextRequired
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

HouseholdIdhouseholdIdtextRequired
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

HouseholdIdhouseholdIdtextRequired
Unique identifier of a household
MemberIdmemberIdnumberRequired
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

PortfolioIdsportfolioIdslistRequired
Unique identifier of a portfolio. Multiple values must be comma-separated.
Enddateenddatedate
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

HouseholdIdshouseholdIdslistRequired
Unique identifier of a household. Multiple values must be comma-separated.
Limitlimitnumber
Limit number of records returned. Default is 100 or 500.At least 1.
Skipskipnumber
Number of results to skipAt least 0.
Countcounttrue/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

Frequencyfrequencytext
Frequency to base results onOne of: monthly, quarterly, annually.
Accumulatedaccumulatedtext
Return accumulated dataOne of: true, false.
Endenddate
End date of time period
Startstartdate
Start date of time period
Flow model IDflow_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 IDrisk_model_idtextRequired
Unique identifier of a risk model
Investment IDSinvestment_idstextRequired
Unique Morningstar identifier for securities. Multiple values must be comma-separated.
Startstartdate
Start date of time period. If start date and end date are not defined, most recent data will be returned.
Endenddate
End date of time period. If start date and end date are not defined, most recent data will be returned.
Frequencyfrequencytext
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 IDrisk_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

SecIdssecIdstextRequired
Unique identifier of a security. Multiple entries must be pipe-separated '|'.
UniverseIdsuniverseIdstext
Unique five-letter identifier created by combining a two-letter Investment Type code and three-letter country code. Multiple entries must be pipe-separated '|'.
LangCultlangCulttext
Language and locale, for example, en-US
DataPointsdataPointstext
Unique identifier of a data point. Can be data point ID or short ID.
CurrencyIdcurrencyIdtext
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

SecIdssecIdstextRequired
Unique identifier of a security. Multiple entries must be pipe-separated '|'.
UniverseIdsuniverseIdstext
Unique five-letter identifier created by combining a two-letter Investment Type code and three-letter country code. Multiple entries must be pipe-separated '|'.
LangCultlangCulttext
Language and locale, for example, en-US
DataPointsdataPointstext
Unique identifier of a data point. Can be data point ID or short ID.
CurrencyIdcurrencyIdtext
ISO 4217 currency code, for example, 'USD'
Request dataPointsrequest_dataPointstext
Datapoints.
SecurityIdssecurityIdstext
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

SecurityDataPointssecurityDataPointstext
Unique identifier of a data point. Can be data point ID or short ID. Multiple values must be pipe-separated.
Request securityDataPointsrequest_securityDataPointstext
Securitydatapoints.
Filtersfilterstext
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

StartIndexstartIndextext
Row to start query from. Zero-based index; first row is '0.'
SecurityTypesecurityTypetext
Unique identifier of a security type
Resultsresultstext
Maximum number of rows to return
Sortsorttext
Sort by data point
Dirdirtext
Sort results in ascending/descending directionOne of: asc, desc.
Outputoutputtext
Format of the returned contentOne of: json.
Langcultlangculttext
Language and locale, for example, en-US
Universeuniversetext
Unique identifier of a universe
SecurityDataPointssecurityDataPointstext
Unique identifier of a data point. Can be data point ID or short ID. Multiple values must be pipe-separated.
Filtersfilterstext
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

Queryquerytext
Text string to search for
Universesuniversestext
Unique five-letter identifier created by combining a two-letter Investment Type code and three-letter country code. Multiple entries must be pipe-separated '|'.
SecurityDataPointssecurityDataPointstext
Data points to return in response. Multiple values must be pipe-separated. Valid values are data point ID or short ID.
Resultsresultstext
Number of rows to limit results to
ResponseSchemaresponseSchematext
Response Schema config in SBT
Schemaschematext
Schema config in SBT
FilterCriteriafilterCriteriatext
Filter express to filter the defined securities in the information retrieved
Langcultlangculttext
Language and locale, for example, en-US
Currencycurrencytext
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
}

On this page