Endpoints by task

Find the job you want, then call its route. Each row gives the task, its REST route and the MCP tool that does the same. Routes are relative to the base URL. The last column links to the page that explains the task.

How the endpoints are grouped

The Endpoints group in the API reference sidebar lists every operation by feature:

Portfolios: list, create and update portfolios, and read a full snapshot.
Holdings and cash: read holdings, set share counts, and record deposits and withdrawals.
Checks: compliance, validation, rebalance preview and change checks.
Rules: scenarios, asset classes, allocation bands, size ranges, the rules text and its restore points.
Setup file: export, preview, apply and undo.
Watchlists, Inputs, Playbooks, Monitors and Charts: the research you keep.
Actions: the record of position and cash changes.
Webhooks, Support and feedback, and Preferences: signed event notifications, support requests and feedback, and what the app opens to.

Reads and checks

Task	Route	MCP tool	Guide
List portfolios and their holding counts	`GET /portfolios`	`list_portfolios`	API quickstart
Read a portfolio with its rules and the symbols to price	`GET /portfolio/snapshot`	`get_portfolio_snapshot`	Prices
Read the same snapshot at prices you supply	`POST /portfolio/snapshot`	`get_portfolio_snapshot`	Prices
Check compliance at prices you supply	`POST /compliance/check`	`get_portfolio_snapshot` (its `compliance` block)	API quickstart
Check a proposed change	`POST /trades/check`	`check_trades`	Check a change
Work out amounts that close a gap	`POST /rebalance/preview`	`get_portfolio_snapshot` with `include_rebalance`	Plan a rebalance
Check proposed allocations for sums and limits	`POST /validate`	`check_allocations`	Allocation bands
Size a position	`POST /positions/size`	`calculate_position_size`	Size a position
Read the record of changes	`GET /actions`	`list_actions`	Action log

Holdings and cash

Task	Route	MCP tool	Guide
Set holdings to the share counts you hold now	`POST /portfolios/{id}/positions/apply`	`save_position`, `replace_positions`	Update with an agent
Record a deposit or withdrawal	`POST /portfolios/{id}/cash-movements`	`record_cash_movement`	Idempotency

Rules and files

Task	Route	MCP tool	Guide
Read or edit scenarios and asset classes	`/scenarios`, `/asset-classes`, `/position-rules`	`save_scenario`, `save_asset_class`, `save_class_rule`	Scenarios
Read or replace rules as rules text	`GET` and `POST /scenarios/{id}/rules`, `GET /rules/spec`	`get_rules`, `preview_rules`, `apply_rules`	Write your rules
List and restore earlier rules	`GET /rules/restore-points`, `POST /rules/restore-points/{id}/restore`	`restore_rules`	Rules text
Export, preview, apply or undo a setup file	`GET /setup/export`, `POST /setup/preview`, `POST /setup/apply`, `GET /setup/receipts`, `POST /setup/receipts/{id}/undo`	`preview_setup`, `apply_setup`, `undo_setup`	ALLOCAIT.md

Research

Task	Route	MCP tool	Guide
Keep watchlists	`/watchlists`	`list_watchlists`, `save_watchlist`, `delete_watchlist`	MCP tools
Keep Inputs and record their values	`/inputs`, `POST /inputs/entries`	`list_inputs`, `save_input`, `record_input_values`	MCP tools
Keep playbooks, monitors and charts	`/playbooks`, `/monitors`, `/charts`	`get_playbook`, `save_playbook`, `save_monitor`, `save_chart`	MCP tools

Events, preferences and feedback

Task	Route	MCP tool	Guide
Subscribe to compliance events	`/webhooks`	none	Webhooks
Read or set display preferences	`GET` and `POST /preferences`	none	none
File support requests and feedback	`/support-requests`, `/agent-feedback`	`send_feedback`	Send feedback

Start

Conventions

Errors

Webhooks

Endpoints

Endpoints by task

How the endpoints are grouped

Reads and checks

Holdings and cash

Rules and files

Research

Events, preferences and feedback

​How the endpoints are grouped

​Reads and checks

​Holdings and cash

​Rules and files

​Research

​Events, preferences and feedback

​Related

How the endpoints are grouped

Reads and checks

Holdings and cash

Rules and files

Research

Events, preferences and feedback

Related