Analyze Portfolio

curl --request POST \
  --url https://api.chicago.global/v1/portfolio/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2024-01-01",
  "end_date": "2024-11-01",
  "base_currency": "USD",
  "benchmark": "ACWI",
  "initial_value": 10000,
  "portfolio": [
    {
      "date": "2024-01-01",
      "symbol": "AAPL.O",
      "weight": 0.25
    },
    {
      "date": "2024-01-01",
      "symbol": "MSFT.O",
      "weight": 0.25
    },
    {
      "date": "2024-01-01",
      "symbol": "GOOGL.O",
      "weight": 0.25
    },
    {
      "date": "2024-01-01",
      "symbol": "AMZN.O",
      "weight": 0.25
    }
  ]
}
'

import requests

url = "https://api.chicago.global/v1/portfolio/analyze"

payload = {
    "start_date": "2024-01-01",
    "end_date": "2024-11-01",
    "base_currency": "USD",
    "benchmark": "ACWI",
    "initial_value": 10000,
    "portfolio": [
        {
            "date": "2024-01-01",
            "symbol": "AAPL.O",
            "weight": 0.25
        },
        {
            "date": "2024-01-01",
            "symbol": "MSFT.O",
            "weight": 0.25
        },
        {
            "date": "2024-01-01",
            "symbol": "GOOGL.O",
            "weight": 0.25
        },
        {
            "date": "2024-01-01",
            "symbol": "AMZN.O",
            "weight": 0.25
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_date: '2024-01-01',
    end_date: '2024-11-01',
    base_currency: 'USD',
    benchmark: 'ACWI',
    initial_value: 10000,
    portfolio: [
      {date: '2024-01-01', symbol: 'AAPL.O', weight: 0.25},
      {date: '2024-01-01', symbol: 'MSFT.O', weight: 0.25},
      {date: '2024-01-01', symbol: 'GOOGL.O', weight: 0.25},
      {date: '2024-01-01', symbol: 'AMZN.O', weight: 0.25}
    ]
  })
};

fetch('https://api.chicago.global/v1/portfolio/analyze', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chicago.global/v1/portfolio/analyze",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_date' => '2024-01-01',
    'end_date' => '2024-11-01',
    'base_currency' => 'USD',
    'benchmark' => 'ACWI',
    'initial_value' => 10000,
    'portfolio' => [
        [
                'date' => '2024-01-01',
                'symbol' => 'AAPL.O',
                'weight' => 0.25
        ],
        [
                'date' => '2024-01-01',
                'symbol' => 'MSFT.O',
                'weight' => 0.25
        ],
        [
                'date' => '2024-01-01',
                'symbol' => 'GOOGL.O',
                'weight' => 0.25
        ],
        [
                'date' => '2024-01-01',
                'symbol' => 'AMZN.O',
                'weight' => 0.25
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chicago.global/v1/portfolio/analyze"

	payload := strings.NewReader("{\n  \"start_date\": \"2024-01-01\",\n  \"end_date\": \"2024-11-01\",\n  \"base_currency\": \"USD\",\n  \"benchmark\": \"ACWI\",\n  \"initial_value\": 10000,\n  \"portfolio\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AAPL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"MSFT.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"GOOGL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AMZN.O\",\n      \"weight\": 0.25\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chicago.global/v1/portfolio/analyze")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_date\": \"2024-01-01\",\n  \"end_date\": \"2024-11-01\",\n  \"base_currency\": \"USD\",\n  \"benchmark\": \"ACWI\",\n  \"initial_value\": 10000,\n  \"portfolio\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AAPL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"MSFT.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"GOOGL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AMZN.O\",\n      \"weight\": 0.25\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chicago.global/v1/portfolio/analyze")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_date\": \"2024-01-01\",\n  \"end_date\": \"2024-11-01\",\n  \"base_currency\": \"USD\",\n  \"benchmark\": \"ACWI\",\n  \"initial_value\": 10000,\n  \"portfolio\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AAPL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"MSFT.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"GOOGL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AMZN.O\",\n      \"weight\": 0.25\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "port-a3522a92-87ed-4be0-a912-ad56ed6a8806",
  "status": "pending",
  "check_url": "/v1/jobs/port-a3522a92-87ed-4be0-a912-ad56ed6a8806",
  "estimated_duration_seconds": 90,
  "message": "Portfolio analysis job created",
  "portfolio_summary": {
    "positions": 4,
    "start_date": "2024-01-01",
    "end_date": "2024-11-01"
  }
}

{
  "detail": "Invalid or missing API key"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

portfolio

analyze

Analyze Portfolio

curl --request POST \
  --url https://api.chicago.global/v1/portfolio/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2024-01-01",
  "end_date": "2024-11-01",
  "base_currency": "USD",
  "benchmark": "ACWI",
  "initial_value": 10000,
  "portfolio": [
    {
      "date": "2024-01-01",
      "symbol": "AAPL.O",
      "weight": 0.25
    },
    {
      "date": "2024-01-01",
      "symbol": "MSFT.O",
      "weight": 0.25
    },
    {
      "date": "2024-01-01",
      "symbol": "GOOGL.O",
      "weight": 0.25
    },
    {
      "date": "2024-01-01",
      "symbol": "AMZN.O",
      "weight": 0.25
    }
  ]
}
'

import requests

url = "https://api.chicago.global/v1/portfolio/analyze"

payload = {
    "start_date": "2024-01-01",
    "end_date": "2024-11-01",
    "base_currency": "USD",
    "benchmark": "ACWI",
    "initial_value": 10000,
    "portfolio": [
        {
            "date": "2024-01-01",
            "symbol": "AAPL.O",
            "weight": 0.25
        },
        {
            "date": "2024-01-01",
            "symbol": "MSFT.O",
            "weight": 0.25
        },
        {
            "date": "2024-01-01",
            "symbol": "GOOGL.O",
            "weight": 0.25
        },
        {
            "date": "2024-01-01",
            "symbol": "AMZN.O",
            "weight": 0.25
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_date: '2024-01-01',
    end_date: '2024-11-01',
    base_currency: 'USD',
    benchmark: 'ACWI',
    initial_value: 10000,
    portfolio: [
      {date: '2024-01-01', symbol: 'AAPL.O', weight: 0.25},
      {date: '2024-01-01', symbol: 'MSFT.O', weight: 0.25},
      {date: '2024-01-01', symbol: 'GOOGL.O', weight: 0.25},
      {date: '2024-01-01', symbol: 'AMZN.O', weight: 0.25}
    ]
  })
};

fetch('https://api.chicago.global/v1/portfolio/analyze', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chicago.global/v1/portfolio/analyze",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_date' => '2024-01-01',
    'end_date' => '2024-11-01',
    'base_currency' => 'USD',
    'benchmark' => 'ACWI',
    'initial_value' => 10000,
    'portfolio' => [
        [
                'date' => '2024-01-01',
                'symbol' => 'AAPL.O',
                'weight' => 0.25
        ],
        [
                'date' => '2024-01-01',
                'symbol' => 'MSFT.O',
                'weight' => 0.25
        ],
        [
                'date' => '2024-01-01',
                'symbol' => 'GOOGL.O',
                'weight' => 0.25
        ],
        [
                'date' => '2024-01-01',
                'symbol' => 'AMZN.O',
                'weight' => 0.25
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chicago.global/v1/portfolio/analyze"

	payload := strings.NewReader("{\n  \"start_date\": \"2024-01-01\",\n  \"end_date\": \"2024-11-01\",\n  \"base_currency\": \"USD\",\n  \"benchmark\": \"ACWI\",\n  \"initial_value\": 10000,\n  \"portfolio\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AAPL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"MSFT.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"GOOGL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AMZN.O\",\n      \"weight\": 0.25\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.chicago.global/v1/portfolio/analyze")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_date\": \"2024-01-01\",\n  \"end_date\": \"2024-11-01\",\n  \"base_currency\": \"USD\",\n  \"benchmark\": \"ACWI\",\n  \"initial_value\": 10000,\n  \"portfolio\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AAPL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"MSFT.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"GOOGL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AMZN.O\",\n      \"weight\": 0.25\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.chicago.global/v1/portfolio/analyze")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_date\": \"2024-01-01\",\n  \"end_date\": \"2024-11-01\",\n  \"base_currency\": \"USD\",\n  \"benchmark\": \"ACWI\",\n  \"initial_value\": 10000,\n  \"portfolio\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AAPL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"MSFT.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"GOOGL.O\",\n      \"weight\": 0.25\n    },\n    {\n      \"date\": \"2024-01-01\",\n      \"symbol\": \"AMZN.O\",\n      \"weight\": 0.25\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "job_id": "port-a3522a92-87ed-4be0-a912-ad56ed6a8806",
  "status": "pending",
  "check_url": "/v1/jobs/port-a3522a92-87ed-4be0-a912-ad56ed6a8806",
  "estimated_duration_seconds": 90,
  "message": "Portfolio analysis job created",
  "portfolio_summary": {
    "positions": 4,
    "start_date": "2024-01-01",
    "end_date": "2024-11-01"
  }
}

{
  "detail": "Invalid or missing API key"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

How It Works

This endpoint uses async job processing for handling large portfolios:

Submit Job: POST your portfolio data to /v1/portfolio/analyze
Receive Job ID: Get a job ID and polling URL immediately
Poll for Status: Check /v1/jobs/{job_id} until status is completed
Get Results: The completed job response contains the full analysis

Processing typically takes 60-120 seconds depending on the date range and number of holdings.

Request Body

Field	Type	Required	Default	Description
`portfolio`	array	Yes	-	List of holdings (see format below)
`start_date`	string	No	First rebalance date	Analysis start date (YYYY-MM-DD)
`end_date`	string	No	Yesterday	Analysis end date (YYYY-MM-DD)
`base_currency`	string	No	`USD`	Base currency (USD, SGD, EUR, etc.)
`benchmark`	string	No	`ACWI`	Benchmark for comparison (e.g., ACWI, SPY)
`initial_value`	number	No	`10000`	Starting portfolio value
`include_transaction_costs`	boolean	No	`false`	Apply market-specific transaction costs
`transaction_cost_config`	object	No	Default rates	Custom transaction cost rates by market
`fields`	array	No	All fields	Select specific response fields

Portfolio Holdings Format

Each item in the portfolio array:

Field	Type	Required	Description
`date`	string	Yes	Rebalance date (YYYY-MM-DD)
`symbol`	string	Yes	Stock symbol (e.g., AAPL.O for Apple Inc)
`weight`	number	Yes	Portfolio weight as decimal (0.25 = 25%)

Weights should sum to 1.0 for each date. They will be normalized if not.

Field Selection

Use the optional fields parameter to return only specific data sections. If omitted, all fields are returned.

{
  "portfolio": [...],
  "fields": ["portfolio_summary", "performance_metrics", "latest_holdings"]
}

Response Fields

The completed analysis includes:

Field	Description
`portfolio_summary`	Final value, total return, P&L breakdown, transaction costs
`turnover_analysis`	Turnover metrics, rebalance frequency, costs by market
`performance_metrics`	Sharpe, Sortino, VaR, volatility, drawdown
`rolling_metrics`	30/60/90-day rolling Sharpe, beta, correlation
`drawdown_analysis`	Drawdown episodes and recovery times
`portfolio_scores`	Quant factor scores (value, quality, momentum)
`latest_holdings`	Current positions with company info
`transactions`	All buy/sell trades
`market_allocation`	Market weights over time
`sector_allocation`	Sector weights over time
`currency_allocation`	Currency weights over time
`company_contribution`	P&L attribution by company
`sector_contribution`	P&L attribution by sector
`market_contribution`	P&L attribution by market
`time_period_returns`	MTD, YTD, 1Y, inception returns
`daily_summary`	Equity curve with benchmark comparison

Example Response

When the job completes, GET /v1/jobs/{job_id} returns:

{
  "job_id": "port-9730dcc9-7a06-495c-85a9-4a405d2140e4",
  "job_type": "portfolio_analysis",
  "status": "completed",
  "result": {
    "success": true,
    "result": {
      "portfolio_parameters": {
        "start_date": "2025-07-01",
        "end_date": "2025-07-31",
        "base_currency": "USD",
        "benchmark": "ACWI",
        "initial_value": 10000.0,
        "include_transaction_costs": false
      },
      "portfolio_summary": {
        "final_value": 9890.37,
        "total_return": -0.0110,
        "total_price_pl": 122.79,
        "total_fx_pl": -232.32,
        "total_pl": -109.63,
        "total_transaction_cost": 0.0,
        "include_transaction_costs": false
      },
      "turnover_analysis": {
        "summary": {
          "days_in_period": 31,
          "num_rebalances": 0,
          "annualized_turnover_pct": 0.0,
          "total_transaction_cost": 0.0,
          "include_transaction_costs": false
        },
        "by_market": {
          "India": { "total_turnover": 0.0, "transaction_cost": 0.0 },
          "Japan": { "total_turnover": 0.0, "transaction_cost": 0.0 },
          "Taiwan": { "total_turnover": 0.0, "transaction_cost": 0.0 },
          "United States": { "total_turnover": 0.0, "transaction_cost": 0.0 }
        }
      },
      "performance_metrics": {
        "portfolio": {
          "total_return": -0.0110,
          "annualized_return": -0.1217,
          "annualized_volatility": 0.1335,
          "max_drawdown": -0.0383,
          "sharpe_ratio": -0.71,
          "sortino_ratio": -1.67,
          "var_95": -0.0093,
          "win_rate": 0.26
        },
        "benchmark": {
          "total_return": 0.0111,
          "sharpe_ratio": 1.28,
          "max_drawdown": -0.0147
        },
        "relative": {
          "beta": 1.52,
          "alpha_annualized": -0.32,
          "correlation": 0.67,
          "information_ratio": -1.67,
          "tracking_error": 0.103
        }
      },
      "portfolio_scores": {
        "value": 42,
        "quality": 65,
        "momentum": 85,
        "defensive": 90,
        "tactical": 37,
        "total": 71
      },
      "latest_holdings": [
        {
          "ric": "2330.TW",
          "weight": 0.295,
          "ending_value": 2918.49,
          "market": "Taiwan",
          "sector": "Technology",
          "recommendation": "STRONG BUY"
        },
        {
          "ric": "RELI.NS",
          "weight": 0.275,
          "ending_value": 2722.05,
          "market": "India",
          "sector": "Energy",
          "recommendation": "HOLD"
        },
        {
          "ric": "7203.T",
          "weight": 0.224,
          "ending_value": 2219.77,
          "market": "Japan",
          "sector": "Consumer Cyclicals",
          "recommendation": "HOLD"
        },
        {
          "ric": "AAPL.O",
          "weight": 0.205,
          "ending_value": 2030.06,
          "market": "United States",
          "sector": "Technology",
          "recommendation": "BUY"
        }
      ],
      "daily_summary": [
        {
          "date": "2025-07-01",
          "portfolio_value": 10000.0,
          "daily_return": 0.0,
          "cumulative_return": 0.0
        },
        {
          "date": "2025-07-31",
          "portfolio_value": 9890.37,
          "daily_return": -0.0097,
          "cumulative_return": -0.0110
        }
      ]
    }
  }
}

Response shown is abbreviated. Full response includes all fields listed above, plus detailed timeseries for allocations, drawdowns, rolling metrics, and more.

Example: Polling for Results

const jobId = response.job_id;
const checkUrl = `https://api.chicago.global/v1/jobs/${jobId}`;

// Poll every 3 seconds
const interval = setInterval(async () => {
  const status = await fetch(checkUrl, {
    headers: { 'Authorization': `Bearer ${API_KEY}` }
  }).then(r => r.json());

  if (status.status === 'completed') {
    clearInterval(interval);
    console.log('Analysis:', status.result);
  } else if (status.status === 'failed') {
    clearInterval(interval);
    console.error('Failed:', status.error);
  } else {
    console.log(`Progress: ${status.progress?.percent}%`);
  }
}, 3000);

Authorizations

Authorization

string

header

required

API key passed as Bearer token

Body

application/json

Request body for portfolio analysis

portfolio

object[]

required

List of holdings with date, symbol, and weight. Weights should sum to 1.0 for each rebalance date. Multiple dates supported for rebalancing.

Minimum array length: 1

Show child attributes

start_date

string<date>

Analysis start date (YYYY-MM-DD). If not provided, defaults to first rebalance date in portfolio.

Example:

"2024-01-01"

end_date

string<date>

Analysis end date (YYYY-MM-DD). If not provided, defaults to yesterday. Future dates are auto-capped to yesterday.

Example:

"2024-11-01"

base_currency

string

default:USD

Base currency for portfolio valuation. Supports USD, SGD, EUR, GBP, JPY, etc.

Example:

"USD"

benchmark

string

default:ACWI

Benchmark for comparison (e.g., ACWI, SPY)

Example:

"ACWI"

initial_value

number

default:10000

Initial portfolio value in base currency. Used to calculate absolute P&L and position sizes.

Example:

10000

include_transaction_costs

boolean

default:false

Apply market-specific transaction costs during rebalancing

Example:

false

transaction_cost_config

object | null

Custom transaction cost rates by market. Format: {'market_name': {'buy': rate, 'sell': rate}}. If not provided, uses default rates.

Example:

{
  "Singapore": { "buy": 0.14, "sell": 0.14 },
  "United States": { "buy": 0.1, "sell": 0.1 }
}

fields

enum<string>[]

Optional field selection. If omitted, all fields are returned. Use this to reduce response size.

Available options:

portfolio_parameters,

portfolio_input,

data_quality,

portfolio_summary,

turnover_analysis,

performance_metrics,

rolling_metrics,

drawdown_analysis,

portfolio_scores,

concentration_metrics,

transactions,

company_info,

latest_holdings,

market_allocation,

sector_allocation,

currency_allocation,

company_contribution,

sector_contribution,

market_contribution,

time_period_returns,

monthly_returns,

annual_returns,

benchmark_prices,

daily_summary

Example:

[
  "portfolio_summary",
  "performance_metrics",
  "latest_holdings"
]

Response

Job created successfully. Poll the check_url for results.

job_id

string

Unique job identifier

status

enum<string>

Initial job status

Available options:

pending

check_url

string

URL to poll for job status

estimated_duration_seconds

integer

Estimated processing time in seconds

message

string

Human-readable status message

portfolio_summary

object

Show child attributes

Get Job Status Portfolio Report

​How It Works

​Request Body

​Portfolio Holdings Format

​Field Selection

​Response Fields

​Example Response

​Example: Polling for Results

Authorizations

Body

Response

How It Works

Request Body

Portfolio Holdings Format

Field Selection

Response Fields

Example Response

Example: Polling for Results