Skip to main content
GET
Get portfolio summary

Authorizations

x-api-key
string
header
required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Query Parameters

limit
integer
default:100

Max rows to return. Default 100, hard max 500 (enforced server-side).

Required range: 1 <= x <= 500
cursor
integer
default:0

Row offset to start from. Default 0. Pass the previous cursor (or 0) plus limit to get the next page.

Required range: x >= 0
portfolio_id
string<uuid>

Omit to list all portfolios for this key's owner

Response

Portfolio summary (a bare object if portfolio_id is given, a {data, has_more} envelope if not)

What the user recorded, unpriced: name, currency, active scenario, position count. No total, no price-freshness fields. Allocait never returns a value computed from its own stored quote on this surface (ADR-036). For a priced total, POST /portfolio/snapshot with prices.

portfolio_id
string<uuid>
name
string
description
string | null
base_currency
enum<string>

Always USD. Allocait supports US dollars only.

Available options:
USD
active_scenario_id
string<uuid> | null
active_scenario_name
string | null
position_count
integer
allow_shorts
boolean

Whether holdings may carry a negative share count (a short). Off by default. Change it with PATCH /portfolios/{id} (ADR-153).