# Morningstar

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/morningstar

## Actions

### Get a category forecast for a flow model

Get a category forecast for a flow model

**Inputs**

- Accumulated (`accumulated`, text): Return accumulated data. One of: `true`, `false`.
- Category ID (`category_id`, text, required): Unique identifier of a category
- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model. One of: `usa-univariate-category-fundflow`.

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get all risk models

Get all risk models

**Inputs**

- Is new (`is_new`, true/false): Return recently created only. One of: `true`, `false`.
- Investment IDS (`investment_ids`, text): Unique Morningstar identifier for securities. Multiple values must be comma-separated.
- Edition (`edition`, text): Internal use only

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get annuity benefits

Get benefits data for variable annuity subaccounts

**Inputs**

- SecIds (`secIds`, text, required): Unique identifier of a security. Multiple entries must be pipe-separated '|'.

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`period`, text): Number of months in time period
- Accumulated (`accumulated`, text): Return accumulated data. One of: `true`, `false`.
- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model. One of: `usa-univariate-category-fundflow`.

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get client profile

Get client profile

**Inputs**

- HouseholdId (`householdId`, text, required): Unique identifier of a household

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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_ids`, text, required): Unique identifier of a fund
- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model. One 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.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get exposures for a share class

Get exposures for a share class

**Inputs**

- Frequency (`frequency`, text): Frequency to base results on. One of: `monthly`, `quarterly`, `annually`.
- Share class IDS (`share_class_ids`, text, required): Unique identifier of a share class
- End (`end`, date): End date of time period
- Start (`start`, date): Start date of time period
- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model. One 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.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get flow model factors

Get flow model factors

**Inputs**

- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get flow models

Get flow models

**Inputs**: None.

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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_ids`, text, required): Unique identifier of a share class
- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model. One 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.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get household profiles

Get household profiles

**Inputs**

- Limit (`limit`, number): Limit number of records returned. Default is 100 or 500. At least 1.
- Skip (`skip`, number): Number of results to skip. At least 0.
- Count (`count`, true/false): Return the total count of profiles. Default is `false`. One of: `true`, `false`.

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`householdId`, text, required): Unique identifier of a household

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`householdId`, text, required): Unique identifier of a household

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`householdId`, text, required): Unique identifier of a household
- MemberId (`memberId`, number, required): Unique identifier of a member

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`portfolioIds`, list, required): Unique identifier of a portfolio. Multiple values must be comma-separated.
- Enddate (`enddate`, date): Return results with end date specified (yyyy-mm-dd, yyyymmdd or LastMonthEnd).

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`householdIds`, list, required): Unique identifier of a household. Multiple values must be comma-separated.
- Limit (`limit`, number): Limit number of records returned. Default is 100 or 500. At least 1.
- Skip (`skip`, number): Number of results to skip. At least 0.
- Count (`count`, true/false): Return the total count of profiles when "limit" or "skip" parameter is used. Default is `false`. One of: `true`, `false`.

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`frequency`, text): Frequency to base results on. One of: `monthly`, `quarterly`, `annually`.
- Accumulated (`accumulated`, text): Return accumulated data. One of: `true`, `false`.
- End (`end`, date): End date of time period
- Start (`start`, date): Start date of time period
- Flow model ID (`flow_model_id`, text, required): Unique identifier of a flow model. One 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.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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_id`, text, required): Unique identifier of a risk model
- Investment IDS (`investment_ids`, text, required): Unique Morningstar identifier for securities. Multiple values must be comma-separated.
- Start (`start`, date): Start date of time period. If start date and end date are not defined, most recent data will be returned.
- End (`end`, date): End date of time period. If start date and end date are not defined, most recent data will be returned.
- Frequency (`frequency`, text): Frequency the response will be based on. One of: `day_end`, `month_start`, `month_end`, `quarter_start`, `quarter_end`.

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get risk model factors

Get risk model factors

**Inputs**

- Risk model ID (`risk_model_id`, text, required): Unique identifer of a risk model

**Outputs**: Value.

- `data` (object): JSON returned by this endpoint; the official specification does not define its fields.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get securities

Get securities data

**Inputs**

- SecIds (`secIds`, text, required): Unique identifier of a security. Multiple entries must be pipe-separated '|'.
- UniverseIds (`universeIds`, text): 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 (`langCult`, text): Language and locale, for example, en-US
- DataPoints (`dataPoints`, text): Unique identifier of a data point. Can be data point ID or short ID.
- CurrencyId (`currencyId`, text): ISO 4217 currency code, for example 'USD'

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`secIds`, text, required): Unique identifier of a security. Multiple entries must be pipe-separated '|'.
- UniverseIds (`universeIds`, text): 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 (`langCult`, text): Language and locale, for example, en-US
- DataPoints (`dataPoints`, text): Unique identifier of a data point. Can be data point ID or short ID.
- CurrencyId (`currencyId`, text): ISO 4217 currency code, for example, 'USD'
- Request dataPoints (`request_dataPoints`, text): Datapoints.
- SecurityIds (`securityIds`, text): Securityids.

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`securityDataPoints`, text): Unique identifier of a data point. Can be data point ID or short ID. Multiple values must be pipe-separated.
- Request securityDataPoints (`request_securityDataPoints`, text): Securitydatapoints.
- Filters (`filters`, text): Filters.

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Screen securities

Get securites and associated data points

**Inputs**

- StartIndex (`startIndex`, text): Row to start query from. Zero-based index; first row is '0.'
- SecurityType (`securityType`, text): Unique identifier of a security type
- Results (`results`, text): Maximum number of rows to return
- Sort (`sort`, text): Sort by data point
- Dir (`dir`, text): Sort results in ascending/descending direction. One of: `asc`, `desc`.
- Output (`output`, text): Format of the returned content. One of: `json`.
- Langcult (`langcult`, text): Language and locale, for example, en-US
- Universe (`universe`, text): Unique identifier of a universe
- SecurityDataPoints (`securityDataPoints`, text): Unique identifier of a data point. Can be data point ID or short ID. Multiple values must be pipe-separated.
- Filters (`filters`, text): Data point ID with either min/max values, or a list of specific values. Multiple criteria must be comma-separated.

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "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 (`query`, text): Text string to search for
- Universes (`universes`, text): 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 (`securityDataPoints`, text): Data points to return in response. Multiple values must be pipe-separated. Valid values are data point ID or short ID.
- Results (`results`, text): Number of rows to limit results to
- ResponseSchema (`responseSchema`, text): Response Schema config in SBT
- Schema (`schema`, text): Schema config in SBT
- FilterCriteria (`filterCriteria`, text): Filter express to filter the defined securities in the information retrieved
- Langcult (`langcult`, text): Language and locale, for example, en-US
- Currency (`currency`, text): ISO 4217 currency code, for example, 'USD'

**Outputs**: Value.

- `data` (object): The API response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value, or empty at the end.

**Example output**

```json
{
  "data": {
    "currency": "example",
    "filterCriteria": "example",
    "langcult": "example",
    "query": "example",
    "responseSchema": "example",
    "schema": "example",
    "securityDataPoints": "example",
    "universes": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
