ResponsePortfolioXray

object

X-Ray response containing analysis results and security reference data.

XRayarray[object]
Show Child Parameters
SecurityReferencearray[object]

Security reference data returned alongside the X-Ray response.

Show Child Parameters
Example

InputAssetClassGroupConfigs

object

Asset class group to query.

AssetClassGroupConfigarray[object]

Asset class group identifier. Maximum of one value can be passed in a request.

Show Child Parameters
Example

InputAssetClassGroupConfig

object
Idstring

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

object

Portfolio-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

object

Object 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