Developers › API reference › Portfolio Center

GET `/api/v1/accounts`

The accounts you can see, valued at the latest simulated closes.

Scope reference:read
operationId portfolioAccounts

The accounts the identity behind the token may view, valued at the latest simulated (or uploaded) closes, with your_permissions on each. Filter by tag or model, ask only for some fields with fields=, and page with cursor. Accounts you may not view never appear, and answer 404 when asked for by id.

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

Paginated. Cursor pagination: limit (1 to 200, default 50); pass next_cursor as cursor until has_more is false. fields= returns only the named fields.

Request

GET /api/v1/accounts

Query parameters

Name	Required	Description
`limit`	no	Page size, 1 to 200 (default 50)
`cursor`	no	The next_cursor of the previous page
`sort`	no	"-id" (newest first, default) or "id"
`fields`	no	Sparse fieldset: comma-separated field names
`tag`	no	Account tag
`model`	no	Model id

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?limit=20&tag=growth&fields=id%2Ccode%2Cname%2Cvalue%2Ccash_pct" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/accounts",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    params={
        "limit": "20",
        "tag": "growth",
        "fields": "id,code,name,value,cash_pct"
    },
    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?limit=20&tag=growth&fields=id%2Ccode%2Cname%2Cvalue%2Ccash_pct", {
  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: a page of Account. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`data`	list of Account	The records of this page.
`data[].id`	id (string)	The record's id (a string of digits).
`data[].code`	string	A short code (unique within its kind).
`data[].name`	string	The account's name.
`data[].strategy`	string	The account's strategy.
`data[].tags`	list of string	Tags used to pick accounts ("growth", "income"…).
`data[].base_currency`	string	The account's currency (ISO 4217).
`data[].model_id`	id (string) or null	The account's model portfolio (null: none).
`data[].lot_method`	string	How lots are picked when selling: "tax_optimal" or "fifo".
`data[].status`	string	"active" or "closed".
`data[].value`	decimal string or null	Value at the latest (simulated) closes.
`data[].cash`	decimal string or null	Cash, as a decimal string.
`data[].cash_pct`	decimal string or null	Cash as a percent of the account's value.
`data[].holdings`	integer	Number of positions.
`data[].your_permissions`	list of string	Your permissions on the account.
`data[].user_defined`	object	User-defined field values by field name.
`data[].created_at`	date-time or null	When it was created.
`next_cursor`	string or null	Pass as ?cursor= for the next page; null on the last page.
`has_more`	boolean	True when another page follows.

Example response

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

{
    "data": [
        {
            "id": "12",
            "code": "GRW-A",
            "name": "Growth Fund A",
            "strategy": "Growth",
            "tags": [
                "growth"
            ],
            "base_currency": "USD",
            "model_id": "1",
            "lot_method": "tax_optimal",
            "status": "active",
            "value": "5240000.00",
            "cash": "162440.00",
            "cash_pct": "3.10",
            "holdings": 24,
            "your_permissions": [
                "view",
                "propose",
                "trade"
            ],
            "user_defined": {
                "Mandate code": "GROWTH-STD"
            },
            "created_at": "2026-10-27T14:30:00Z"
        }
    ],
    "next_cursor": null,
    "has_more": false
}

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`
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"
}

On the screens

The same thing in the app is explained in: