InputAssetClassGroupConfig
objectIdstring
Asset class group identifier.
Allowed values:ACG-AUDETAILEDACG-BROAD-INDIA2ACG-BROAD-JAPANACG-CABROADACG-CANBROAD4ACG-EUBROADACG-GLOBBROADACG-NZDETAILEDACG-UKBROADACG-UK-GBRACG-USBROAD
Default:ACG-USBROAD
Example
InputPortfolioFees
objectPortfolio-level annual fee configuration.
AnnualFeePercentnumber(double)
Annual fee as a percentage of portfolio value (e.g. 1.15 = 1.15%). Defaults to 0 (no fee).
Default:0
>= 0
Example:1.15
AnnualFeeFrequencystring
How often the annual fee is deducted from the portfolio.
Allowed values:MonthlyQuarterlySemiAnnuallyAnnually
Default:Monthly
Example
InputPortfolio
objectObject representing a portfolio to be analysed. Each holding must specify a security identifier and either Weight or Value to define its allocation. TotalValue is required when holdings use Weight.
Namestringrequired
Portfolio name.
TotalValuenumber(double)
Total market value of the portfolio in the portfolio currency. Required when holdings use Weight.
>= 1
Example:20000
Currencystringrequired
Portfolio currency. 19 currencies are supported. Accepted values are ISO 4217 currency codes…
Allowed values:AUDBRLCADCHFDKKEURGBPHKDINRJPYMXNMYRNOKNZDSEKSGDTWDUSDZAR
Example:USD
Holdingsarray[object]required
Each holding requires a security identifier and a position size. For the identifier, pass one of: SecurityId, CUSIP, FundCode, ISIN, PerformanceId, or TradingSymbol. If multiple identifiers are provided for a single security, SecurityId takes priority; if SecurityId is absent, the last identifier listed in the object is used. For the position size, pass either of: Weight or Value.
>= 1 items<= 250 items
Show Child Parameters
Feesobject
Portfolio-level annual fee configuration.
Show Child Parameters
IrrFeesnumber(double)
Annual fee used in the internal rate of return calculation.
>= 1
Example:1000
Example
InputPortfolioHolding
objectEach holding requires a security identifier and a position size. For the identifier, pass one of: SecurityId, CUSIP, FundCode, ISIN, PerformanceId, or TradingSymbol. If multiple identifiers are provided for a single security, SecurityId takes priority; if SecurityId is absent, the last identifier listed in the object is used. For the position size, pass either of: Weight or Value.
SecurityIdstring
Morningstar unique identifier of a security. Use CASH%0.000 for cash positions.
Example:FOUSA00DFS, CASH%0.000
CUSIPstring
Security’s CUSIP.
Example:09251T103
ISINstring
Security’s ISIN.
Example:US0378331005
PerformanceIdstring
Security’s Morningstar Performance ID.
Example:0P00002QN3
TradingSymbolstring
“Security’s ticker/trading symbol.”
Example:MDLOX
FundCodestring
Security’s fund code.
Example:ABG
Weightnumber(double)
Holding weight as a percentage of portfolio total. All holding weights must sum to 100.
>= 1<= 100
Example:60
Valuenumber(double)
Market value of the holding in the portfolio currency. Sum of all holdings must equal portfolio TotalValue.
>= 1
Example:25000
AnnualFeeFrequencystring
How often the holding-level annual fee is deducted.
Allowed values:MonthlyQuarterlySemiAnnuallyAnnually
Default:Monthly
AnnualFeePercentnumber(double)
Holding-level annual fee as a percentage of holding value (e.g. 1.15 = 1.15%). Defaults to 0 (no fee).
Default:0
>= 0
Example:1.15
Example
InputXRayConfig
objectIdstring
Account-specific configuration preset. Settings can be overridden directly in the request.
Allowed values:Default
Default:Default
Example