Generating Portfolio X-Rays

The Portfolio X-Ray API analyzes one or two portfolios and returns how each is diversified by region, sector and investment style, along with holdings, fee, return and risk data. A single endpoint, POST /portfolioanalysis/v1/xray, handles every request.

Workflow

Generating an X-Ray follows these steps.

1. Get an access token. Request a token from the Authentication API and include it in the Authorization header. See Getting Started.
2. Build the request. Define up to two portfolios, identify each holding and size each position. See Request Structure.
3. Configure the analysis. Choose a view, set the analysis period and add optional data sections. See Configuring the Analysis.
4. Send the request. Post the request body to the endpoint. See Request Portfolio X-Ray.
5. Read the response. Each portfolio returns as one object in the XRay array. See Understanding the Response.

Analyzing One or Two Portfolios

You can send one portfolio to analyze it on its own, or two portfolios in the same request. When you send two, you can align their analysis periods so that the results are comparable. See Compare Two Portfolios.

In This Section