Developers › API reference › Portfolio Center

GET `/api/v1/accounts/{id}/risk`

Concentration, exposures and factor betas.

Scope portfolio:read
operationId portfolioRisk

The token needs the scope portfolio:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/accounts/{id}/risk

Path parameters

Name	Description	Example
`id`	The id of the account.	`12`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/accounts/12/risk" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/accounts/12/risk",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/accounts/12/risk", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: Risk. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`account_id`	id (string)	The account's id.
`value`	decimal string or null	Value at the latest (simulated) closes.
`cash_pct`	decimal string or null	Cash as a percent of the account's value.
`holdings`	integer	Number of positions.
`top_position`	object or null	The largest position.
`top5_pct`	decimal string or null	Weight of the five largest positions, in percent.
`hhi`	decimal string or null	Herfindahl-Hirschman concentration index of the weights.
`effective_n`	decimal string or null	Effective number of holdings (1 / HHI).
`sectors`	object	Weights by sector, in percent.
`issuers`	object	Weights by issuer, in percent.
`factor_betas`	any	Simulated factor betas (market, size, value, momentum).
`volatility_pct`	decimal string or null	Annualised volatility of the simulated returns, in percent.
`correlation_spikes`	list	Pairs of holdings whose recent correlation jumped.
`simulated`	boolean	Always true: simulated data, paper trading.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "account_id": "12",
    "value": "5240000.00",
    "cash_pct": "3.10",
    "holdings": 24,
    "top_position": {
        "symbol": "AAPL",
        "weight_pct": "6.2"
    },
    "top5_pct": "28.4",
    "hhi": "0.054",
    "effective_n": "18.4",
    "sectors": {
        "Information Technology": "31.2"
    },
    "issuers": {
        "AAPL": "6.2"
    },
    "factor_betas": {
        "market": "1.08"
    },
    "volatility_pct": "18.2",
    "correlation_spikes": [],
    "simulated": true
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/accounts/12/risk"
}

On the screens

The same thing in the app is explained in:

Portfolio Center: accounts, holdings, drift and risk