{
"opencollection": "1.0.0",
"info": {
"name": "Authorization Tokens Accounts Fund-Level Sustainability Ratings, Research, and Analytics API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"items": [
{
"info": {
"name": "Fund-Level Sustainability Ratings, Research, and Analytics",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Absolute Carbon Emissions Scope 1 And 2 Tonnes time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/absolute-carbon-emissions-scope-1-and-2-tonnes/: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 scope 1 and 2 carbon emissions that is attributable to the portfolio, calculated by working out for each unique holding the percentage of that company that the portfolio owns."
},
{
"info": {
"name": "Get Absolute Carbon Emissions Scope 1 And 2 Tonnes Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/absolute-carbon-emissions-scope-1-and-2-tonnes-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 Absolute Carbon Emissions (scope 1 and 2 emissions) for funds within the Morningstar category expressed in tonnes."
},
{
"info": {
"name": "Get Absolute Carbon Intensity 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-sustainability/absolute-carbon-intensity-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, divided by the total revenue in millions (in relevant currency) attributable to the portfolio."
},
{
"info": {
"name": "Get Absolute Carbon Intensity 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-sustainability/absolute-carbon-intensity-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 Absolute Carbon Intensity (scope 1 and 2) for portfolios within the Morningstar category expressed in tonnes per million (in relevant currency) invested."
},
{
"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-sustainability/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-sustainability/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 Eligible Holding Type time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-eligible-holding-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": "An indication of which of the Corporate, Sovereign or Other classifications is eligible for calculations."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Number Of Holdings Covered time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-number-of-holdings-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 number of the long, eligible holdings of the 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 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-sustainability/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 Eligible Portfolio Not Covered time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-percentage-of-eligible-portfolio-not-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 that does not have the relevant underlying data for the calculation of the carbon footprint statistics."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Percentage Of Portfolio Covered time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-percentage-of-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-only 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-sustainability/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 Percentage Of Portfolio Eligible Not Covered time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-percentage-of-portfolio-eligible-not-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-only portfolio that is eligible for the calculation, but for which the relevant underlying data for purposes of the calculation of the carbon footprint statistics is not available."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Percentage Of Portfolio Not Covered time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-percentage-of-portfolio-not-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-only portfolio that does not have the relevant underlying data for the calculation of the carbon footprint statistics."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Percentage Of Portfolio Not Eligible time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-percentage-of-portfolio-not-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 not considered eligible for carbon footprint calculations."
},
{
"info": {
"name": "Get Carbon Footprint Scope 1 And 2 Tonnes Per AUD Million Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-aud-million-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 Carbon Footprint Scope 1 And 2 Tonnes Per AUD Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-aud-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 CHF Million Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-chf-million-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 Carbon Footprint Scope 1 And 2 Tonnes Per CHF Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-chf-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 EUR Million Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-eur-million-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 Carbon Footprint Scope 1 And 2 Tonnes Per EUR Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-eur-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 GBP Million Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-gbp-million-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 Carbon Footprint Scope 1 And 2 Tonnes Per GBP Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-gbp-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 HKD Million Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-hkd-million-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 Carbon Footprint Scope 1 And 2 Tonnes Per HKD Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-hkd-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 SGD Million Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-sgd-million-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 Carbon Footprint Scope 1 And 2 Tonnes Per SGD Millions time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-footprint-scope-1-and-2-tonnes-per-sgd-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 time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/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-sustainability/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 Carbon Risk Level Classification time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-risk-level-classification/: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 fund's Historical Carbon Risk Score is assigned to one of five risk categories:Portfolio Carbon Risk Score Risk Level0 Negligible 0."
},
{
"info": {
"name": "Get Carbon Risk Score Category Average time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-risk-score-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 Risk Score for portfolios within the Morningstar Category."
},
{
"info": {
"name": "Get Carbon Risk Score Percent Rank In Category time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/carbon-risk-score-percent-rank-in-category/: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 portfolio's percent rank within its Morningstar Category, based on its Portfolio Carbon Risk Score."
},
{
"info": {
"name": "Get Historical Carbon Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/historical-carbon-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 historical weighted average of the trailing 12 months of Portfolio Carbon Risk Scores. Historical portfolio scores are not equal-weighted; rather, more-recent portfolios are weighted more heavily than older portfolios."
},
{
"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-sustainability/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-sustainability/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 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-sustainability/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 Portfolio Carbon Risk Score time series.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://www.us-api.morningstar.com/token/direct-web-services/time-series/v1/fund-sustainability/portfolio-carbon-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 carbon risk scores for the portfolio's covered, corporate holdings."
},
{
"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-sustainability/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-sustainability/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-sustainability/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-sustainability/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-sustainability/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-sustainability/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-sustainability/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-sustainability/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-sustainability/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."
}
]
}
],
"bundled": true
}