OutputXRayStatisticsPortfolioStatisticsSummary
objectPortfolio summary statistics.
PortfolioValuenumber(double)
Total value of the portfolio.
Currencystring
Currency of the fund returns.
Allowed values:AUDBRLCADCHFDKKEURGBPHKDINRJPYMXNMYRNOKNZDSEKSGDTWDUSDZAR
PortfolioDatestring(date-time)
The date the portfolio was reported.
EquityCountinteger(int32)
Number of equity holdings in the portfolio.
FixedIncomeCountinteger(int32)
Number of fixed income holdings in the portfolio.
SECYieldnumber(double)
Standardized yield calculated over the 30-day period ending on the last day of the previous month, based on maximum offering price.
PortfolioYieldarray[object]
Show Child Parameters
Example
OutputXRayStatisticsSecurityFundStatisticsItem
objectAverageNetExpenseRationumber(double)
Percentage of fund assets, net of reimbursements, used to pay operating expenses and management fees. Does not include brokerage or sales charges.
AverageGrossExpenseRationumber(double)
Percentage of fund assets used to pay operating expenses and management fees before any reimbursements. Does not include brokerage or sales charges.
PotentialCapGainsExposurenumber(double)
Estimated percentage of fund assets representing unrealized gains. An indicator of possible future capital gain distributions.
Example
OutputXRayStatisticsStatisticsItem
objectStatistics data.
PortfolioSummaryobject
Portfolio summary statistics.
Show Child Parameters
FundStatisticsobject
Fund statistics data.
Show Child Parameters
Example
OutputXRayXRay
objectPortfolioNamestring
Name of the portfolio queried.
PerformanceDateobject
Key performance date reference points for the portfolio.
Show Child Parameters
AnalysisDatestring(date-time)
Date of analysis.
ReturnMethodologystring
Return methodology used in the calculation.
Allowed values:QuickPortfolio
Analysisobject
Analysis data.
Show Child Parameters
Holdingsobject
Holdings data.
Show Child Parameters
Statisticsobject
Statistics data.
Show Child Parameters
PortfolioBenchmarkobject
Portfolio benchmark data.
Show Child Parameters
Returnsobject
Returns data.
Show Child Parameters
SecurityFeesobject
Fee data for each security in the portfolio.
Show Child Parameters
Risksobject
Risk data.
Show Child Parameters
Ownershipobject
Ownership zone data for equity holdings.
Show Child Parameters
FinraHeaderobject
FINRA disclosure header message.
Show Child Parameters
Example
OutputToken
objectA successful authentication response containing a JWT bearer token.
access_tokenstringrequired
The signed JWT to use as a Bearer token in subsequent authenticated requests.
Example:eyJhbGciOiJ example
expires_inintegerrequired
The number of seconds until the token expires. After expiry, request a new token.
Example:3599
token_typestringrequired
The token type. Always Bearer.
Example:Bearer
Example