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
ErrorResponseAuthentication
objectA response body returned when authentication fails.
* Additional properties are NOT allowed.
error_messagestringrequired
A human-readable description of the error.
Example:Incorrect username or password
Example