{
"opencollection": "1.0.0",
"info": {
"name": "Authorization Tokens Accounts Fund Research, Ratings and Analytics API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"items": [
{
"info": {
"name": "Fund Research, Ratings and Analytics",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 And 3 Tonnes Per Usd Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/carbon-footprint-scope-1-and-2-and-3-tonnes-per-usd-millions/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The amount (in tonnes) of total Scope 1, 2 and 3 carbon emissions attributable to the portfolio, per million units (in relevant currency) invested."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 And 3 Tonnes Per Usd Millions Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/carbon-footprint-scope-1-and-2-and-3-tonnes-per-usd-millions-category-average/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The average Carbon Footprint (scope 1, 2 and 3 emissions) for portfolios within the Morningstar Category expressed in tonnes per million invested for the relevant currency."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Percentage Of Eligible Portfolio Covered time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/carbon-footprint-scope-1-and-2-percentage-of-eligible-portfolio-covered/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The percentage of the long, eligible portfolio with the relevant underlying data for the calculation of the carbon footprint statistics."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Percentage Of Portfolio Eligible time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/carbon-footprint-scope-1-and-2-percentage-of-portfolio-eligible/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The percentage of the long-only portfolio that is considered eligible for carbon footprint calculations."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Tonnes Per Usd Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/carbon-footprint-scope-1-and-2-tonnes-per-usd-millions/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The amount (in tonnes) of total Scope 1 and 2 carbon emissions attributable to the portfolio, per million units (in relevant currency) invested."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Tonnes Per Usd Millions Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/carbon-footprint-scope-1-and-2-tonnes-per-usd-millions-category-average/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The average Carbon Footprint (scope 1 and 2 emissions) for portfolios within the Morningstar Category expressed in tonnes per million invested for the relevant currency."
},
{
"info": {
"name": "Get Five Year Five Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-five-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 5-year Morningstar Star Rating of 5-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Five Year Four Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-four-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 5-year Morningstar Star Rating of 4-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Five Year Not Star Rated Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-not-star-rated-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are eligible but do not receive an 5-year Morningstar Star Rating."
},
{
"info": {
"name": "Get Five Year Not Star Rating Eligible Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-not-star-rating-eligible-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are not eligible for an 5-year Morningstar Star Rating."
},
{
"info": {
"name": "Get Five Year One Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-one-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 5-year Morningstar Star Rating of 1-star. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Five Year Three Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-three-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 5-year Morningstar Star Rating of 3-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Five Year Two Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/five-year-two-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 5-year Morningstar Star Rating of 2-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Historical Corporate ESG Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/historical-corporate-esg-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Historical Corporate ESG Risk Score is a weighted average of the trailing 12 months of Morningstar Portfolio Corporate ESG Risk Scores."
},
{
"info": {
"name": "Get Historical Sovereign ESG Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/historical-sovereign-esg-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Historical Sovereign ESG Risk Score is a weighted average of the trailing 12 months of Morningstar Portfolio Sovereign ESG Risk Scores."
},
{
"info": {
"name": "Get Monthly Return time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/monthly-return/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Expressed in percentage terms, Morningstar's calculation of total return is determined each month by taking the change in monthly net asset value, reinvesting all income and capital-gains distributions during that month, and dividing by the starting NAV."
},
{
"info": {
"name": "Get Morningstar ESG Risk Rating For Funds time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-esg-risk-rating-for-funds/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar assigns ESG Risk Ratings by combining a portfolio's Corporate ESG Risk Rating and Sovereign ESG Risk Rating proportional to the relative weight of the (long only) corporate and sovereign positions, rounded to the nearest whole number."
},
{
"info": {
"name": "Get Morningstar Medalist Rating time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar Medalist Rating The Morningstar Medalist Rating for funds is the summary expression of our forward-looking analysis of investment strategies as offered via the specific vehicles under coverage."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Parent Pillar time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-parent-pillar/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar Medalist Rating – Parent Pillar We believe the parent organization is important in evaluating both active and passive funds."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Parent Pillar Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-parent-pillar-type/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The type of Morningstar Medalist Rating Parent Pillar."
},
{
"info": {
"name": "Get Morningstar Medalist Rating People Pillar time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-people-pillar/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar Medalist Rating – People Pillar The overall quality of a strategy's investment team is a significant key to a strategy's ability to deliver superior performance relative to its benchmark and/or peers."
},
{
"info": {
"name": "Get Morningstar Medalist Rating People Pillar Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-people-pillar-type/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The type of Morningstar Medalist Rating People Pillar."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Performance Pillar time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-performance-pillar/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar Medalist Rating – Performance Pillar We do not believe past performance is necessarily predictive of future results, and this factor accordingly receives no explicit weighting in our analysis but is referenced instead in our evaluation of people and process."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Performance Pillar Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-performance-pillar-type/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The type of Morningstar Medalist Rating Performance Pillar."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Price Pillar time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-price-pillar/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar Medalist Rating – Price Pillar Morningstar and independent academic research has shown that expenses are one of the better predictors of future outperformance even when evaluating net-of-fee returns."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Price Pillar Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-price-pillar-type/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The type of Morningstar Medalist Rating Price Pillar."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Process Pillar time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-process-pillar/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar Medalist Rating – Process Pillar The Morningstar Medalist Rating is style-agnostic, meaning that, for equity strategies, we do not prefer value to growth or momentum, or vice versa."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Process Pillar Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-process-pillar-type/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The type of Morningstar Medalist Rating Process Pillar."
},
{
"info": {
"name": "Get Morningstar Medalist Rating Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-medalist-rating-type/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Get Morningstar Medalist Rating Type time series."
},
{
"info": {
"name": "Get Morningstar Rating Overall time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/morningstar-rating-overall/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Rating evaluates managed investments based on their risk-adjusted performance relative to their category peers."
},
{
"info": {
"name": "Get Overall Five Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-five-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an Overall Morningstar Star Rating of 5-stars."
},
{
"info": {
"name": "Get Overall Four Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-four-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an Overall Morningstar Star Rating of 4-stars."
},
{
"info": {
"name": "Get Overall Not Star Rated Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-not-star-rated-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are eligible but do not receive an Overall Morningstar Star Rating."
},
{
"info": {
"name": "Get Overall Not Star Rating Eligible Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-not-star-rating-eligible-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are not eligible for an Overall Morningstar Star Rating."
},
{
"info": {
"name": "Get Overall One Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-one-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an Overall Morningstar Star Rating of 1-star. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Overall Three Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-three-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an Overall Morningstar Star Rating of 3-stars."
},
{
"info": {
"name": "Get Overall Two Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/overall-two-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an Overall Morningstar Star Rating of 2-stars."
},
{
"info": {
"name": "Get Portfolio Corporate ESG Risk Rating time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-corporate-esg-risk-rating/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar assigns Corporate ESG Risk Ratings by ranking all scored funds within a Morningstar Global Category by their Historical Corporate ESG Risk Scores."
},
{
"info": {
"name": "Get Portfolio Corporate ESG Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-corporate-esg-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Portfolio Corporate ESG Risk Score is an asset-weighted average of Sustainalytics' company-level ESG Risk Score."
},
{
"info": {
"name": "Get Portfolio Environmental Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-environmental-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The asset-weighted average of the Company Environmental Risk scores for the covered corporate holdings in a portfolio."
},
{
"info": {
"name": "Get Portfolio ESG Risk Rating time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-esg-risk-rating/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar assigns ESG Risk Ratings by combining a portfolio's Corporate ESG Risk Rating and Sovereign ESG Risk Rating proportional to the relative weight of the (long only) corporate and sovereign positions, rounded to the nearest whole number."
},
{
"info": {
"name": "Get Portfolio Governance Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-governance-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The asset-weighted average of the company Governance Risk Scores for the covered corporate holdings in a portfolio."
},
{
"info": {
"name": "Get Portfolio Social Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-social-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The asset-weighted average of the Company Social Risk Scores for the covered corporate holdings in a portfolio."
},
{
"info": {
"name": "Get Portfolio Sovereign ESG Risk Rating time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-sovereign-esg-risk-rating/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "Morningstar assigns Sovereign ESG Risk Ratings by ranking all scored funds within a Morningstar Global Category by their Historical Sovereign ESG Risk Scores."
},
{
"info": {
"name": "Get Portfolio Sovereign ESG Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-sovereign-esg-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Portfolio Sovereign ESG Risk Score is an asset-weighted average of Sustainalytics' Country Risk Score."
},
{
"info": {
"name": "Get Portfolio Unallocated Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/portfolio-unallocated-risk-score/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The asset-weighted average of the Company ESG Risk scores for the covered corporate holdings in a portfolio that do not have Environmental, Social, Governance scores."
},
{
"info": {
"name": "Get Rating 10 Year time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/rating-10-yr/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Rating evaluates managed investments based on their risk-adjusted performance relative to their category peers."
},
{
"info": {
"name": "Get Rating 3 Year time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/rating-3-yr/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Rating evaluates managed investments based on their risk-adjusted performance relative to their category peers."
},
{
"info": {
"name": "Get Rating 5 Year time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/rating-5-yr/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The Morningstar Rating evaluates managed investments based on their risk-adjusted performance relative to their category peers."
},
{
"info": {
"name": "Get Ten Year Five Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-five-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 10-year Morningstar Star Rating of 5-stars."
},
{
"info": {
"name": "Get Ten Year Four Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-four-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 10-year Morningstar Star Rating of 4-stars."
},
{
"info": {
"name": "Get Ten Year Not Star Rated Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-not-star-rated-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that are eligible but do not receive an 10-year Morningstar Star Rating."
},
{
"info": {
"name": "Get Ten Year Not Star Rating Eligible Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-not-star-rating-eligible-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are not eligible for an 10-year Morningstar Star Rating."
},
{
"info": {
"name": "Get Ten Year One Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-one-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 10-year Morningstar Star Rating of 1-star. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Ten Year Three Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-three-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 10-year Morningstar Star Rating of 3-stars."
},
{
"info": {
"name": "Get Ten Year Two Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/ten-year-two-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 10-year Morningstar Star Rating of 2-stars."
},
{
"info": {
"name": "Get Three Year Five Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-five-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 3-year Morningstar Star Rating of 5-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Three Year Four Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-four-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 3-year Morningstar Star Rating of 4-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Three Year Not Star Rated Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-not-star-rated-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are eligible but do not receive an 3-year Morningstar Star Rating."
},
{
"info": {
"name": "Get Three Year Not Star Rating Eligible Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-not-star-rating-eligible-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive are not eligible for an 3-year Morningstar Star Rating."
},
{
"info": {
"name": "Get Three Year One Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-one-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 3-year Morningstar Star Rating of 1-star. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Three Year Three Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-three-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 3-year Morningstar Star Rating of 3-stars. This is calculated on the base portfolio, and only considers long positions."
},
{
"info": {
"name": "Get Three Year Two Star Rating Percent time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-research/three-year-two-star-rating-percent/:ids",
"params": [
{
"name": "ids",
"value": "",
"type": "path",
"description": "\nComma-separated list of up to 25 investment identifiers to query.\n\nAccepts:\n\n- Morningstar Performance ID (default)\n- Morningstar Security ID\n- Morningstar IDs (MSID)\n- ISIN\n- CUSIP\n- Trading symbol\n- Category ID \n Important: When a category ID is passed, the corresponding `identifierType` can be `performanceId` or `securityId`. The value must be URL-encoded. For example, if the category ID is `LC00002226;CA]FO`, the URL-encoded value is `LC00002226;CA%5DFO`."
},
{
"name": "idTypes",
"value": "",
"type": "query",
"description": "\nComma-separated list specifying the type of each value passed in the `ids` parameter.
\nRules:\n\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n* Empty values default to `performanceId`\n\nExample:\n\n* `ids=id1,id2,id3`\n* `id1` and `id3` are performance IDs\n* `id2` is a security ID\n* `idTypes=,securityId`\n\nAccepted values:\n\n* `performanceId` (default)\n* `isin`\n* `securityId`\n* `cusip`\n* `tradingSymbol`\n* `msid`"
},
{
"name": "baseCurrency",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 4217 currency codes (for example, `CAD`, `EUR`, `JPY`).
\n\n* Filters results based on currency\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Base currency passed for `id2` and `id4`\n* `baseCurrency=,USD,,USD`"
},
{
"name": "domicile",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`). \nRules:\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Domicile passed for `id2` and `id4`\n* `domicile=,USA,,USA`"
},
{
"name": "exchangeCountry",
"value": "",
"type": "query",
"description": "\nComma-separated list of 3-character ISO 3166‑1 country codes (for example, `CAN`, `IRL`, `IND`).\n\n\n* Filters results based on domicile\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange country passed for `id2` and `id4`\n* `exchangeCountry=,USA,,USA`"
},
{
"name": "exchangeId",
"value": "",
"type": "query",
"description": "\nComma-separated list of exchange IDs (for example, `EX$$$$XMEX`, `EX$$$$XNAS`).\n\n* Filters results based on exchange ID\n* Values must align with the order of values in `ids`\n* Use empty entries to skip\n* Omit trailing commas after the last non-empty value\n\nExample:\n\n* `ids=id1,id2,id3,id4,id5`\n* Exchange ID passed for `id2` and `id4`\n* `exchangeId=,EX$$$$XMEX,,EX$$$$XNAS`"
},
{
"name": "frequency",
"value": "",
"type": "query",
"description": "Specifies the time interval between data points."
},
{
"name": "startDate",
"value": "",
"type": "query",
"description": "Specifies the start date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "endDate",
"value": "",
"type": "query",
"description": "Specifies the end date for the time series. Accepted format is `yyyy-MM-dd`.\n"
},
{
"name": "timePeriod",
"value": "",
"type": "query",
"description": "Specifies the size of the time window for the data range. \n\n- Used in combination with `timePeriodUnit` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "timePeriodUnit",
"value": "",
"type": "query",
"description": "\nSpecifies the time period unit. \n\n- Used in combination with `timePeriod` to specify relative time ranges. \n\n- When `startDate`, `endDate`, `timePeriod` and `timePeriodUnit` are provided, `timePeriod` and `timePeriodUnit` take precedence."
},
{
"name": "applyEarliestCommonDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the earliest common start date across all investments.\n\n When set to `true`, the start date of the time series is adjusted to match the latest inception date among the investments, ensuring all data points are aligned."
},
{
"name": "applyTrackRecordExtension",
"value": "",
"type": "query",
"description": "\nSpecifies whether to apply the Track Record Extension logic in order to extend the performance of an investment by copying the historical performance of another qualified older investment."
},
{
"name": "applyRestructureDate",
"value": "",
"type": "query",
"description": "\nSpecifies whether to consider the Morningstar or Custom restructure date when determining the start of the performance period.\n\nThis option is applicable only when `applyEarliestCommonDate` is set to true."
},
{
"name": "sinceInception",
"value": "",
"type": "query",
"description": "\nSets the time range from inception (or the maximum supported lookback) to the end date. \n\nTakes precendence over any `timePeriod` / `timePeriodUnit` and `startDate` / `endDate` settings."
},
{
"name": "currencyId",
"value": "",
"type": "query",
"description": "Specifies the currency in which to return data."
}
]
},
"docs": "The proportion of the investment holdings that receive an 3-year Morningstar Star Rating of 2-stars. This is calculated on the base portfolio, and only considers long positions."
}
]
}
],
"bundled": true
}