Skip to main content
GET
Export your watchlists, Inputs, playbooks, monitors and saved charts as one JSON document

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

portfolio_id
string<uuid>

Narrows portfolios to this portfolio. Watchlists, Inputs and custom classes are always the whole account's.

Response

The setup file

The definitions of your research layer as one versioned document: your own asset classes that a watchlist names, watchlists with their symbols, Input definitions with their options, and for each portfolio that has any, its playbooks, monitors and saved charts. It holds no recorded value, price, holding, level, rule, scenario, action, preference, webhook, key or id. Where a save call takes an id, the file carries a name (a watchlist, Input or portfolio name). Order is fixed: lists sort by name without regard to case, a watchlist keeps its symbol order, and a playbook, chart or Input keeps its own column or option order. A key added later does not change version; a key renamed, removed or given a different meaning does.

format
string
required
Allowed value: "allocait.setup"
version
integer
required
custom_asset_classes
object[]
required

Your own asset classes that a watchlist item below names. System classes are everyone's and are named only.

watchlists
object[]
required
inputs
object[]
required
portfolios
object[]
required

Only portfolios that have a playbook, a monitor or a saved chart, by name. No holding, cash or rule is listed.