> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allocait.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoints by task

> Which endpoint to call for each job.

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](https://docs.allocait.app/api/introduction.md#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](https://docs.allocait.app/api/quickstart.md) |
| Read a portfolio with its rules and the symbols to price | `GET /portfolio/snapshot` | `get_portfolio_snapshot` | [Prices](https://docs.allocait.app/concepts/prices.md) |
| Read the same snapshot at prices you supply | `POST /portfolio/snapshot` | `get_portfolio_snapshot` | [Prices](https://docs.allocait.app/concepts/prices.md) |
| Check compliance at prices you supply | `POST /compliance/check` | `get_portfolio_snapshot` (its `compliance` block) | [API quickstart](https://docs.allocait.app/api/quickstart.md) |
| Check a proposed change | `POST /trades/check` | `check_trades` | [Check a change](https://docs.allocait.app/guides/check-before-you-trade.md) |
| Work out amounts that close a gap | `POST /rebalance/preview` | `get_portfolio_snapshot` with `include_rebalance` | [Plan a rebalance](https://docs.allocait.app/guides/plan-a-rebalance.md) |
| Check proposed allocations for sums and limits | `POST /validate` | `check_allocations` | [Allocation bands](https://docs.allocait.app/concepts/allocation-bands.md) |
| Size a position | `POST /positions/size` | `calculate_position_size` | [Size a position](https://docs.allocait.app/guides/size-a-position.md) |
| Read the record of changes | `GET /actions` | `list_actions` | [Action log](https://docs.allocait.app/concepts/action-log.md) |

## 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](https://docs.allocait.app/guides/update-with-an-agent.md) |
| Record a deposit or withdrawal | `POST /portfolios/{id}/cash-movements` | `record_cash_movement` | [Idempotency](https://docs.allocait.app/api/idempotency.md) |

## 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](https://docs.allocait.app/concepts/scenarios.md) |
| 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](https://docs.allocait.app/guides/write-your-rules.md) |
| List and restore earlier rules | `GET /rules/restore-points`, `POST /rules/restore-points/{id}/restore` | `restore_rules` | [Rules text](https://docs.allocait.app/concepts/rules-text.md) |
| 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](https://docs.allocait.app/concepts/setup-file.md) |

## Research

| Task | Route | MCP tool | Guide |
| - | - | - | - |
| Keep watchlists | `/watchlists` | `list_watchlists`, `save_watchlist`, `delete_watchlist` | [MCP tools](https://docs.allocait.app/claude/tools.md) |
| Keep Inputs and record their values | `/inputs`, `POST /inputs/entries` | `list_inputs`, `save_input`, `record_input_values` | [MCP tools](https://docs.allocait.app/claude/tools.md) |
| Keep playbooks, monitors and charts | `/playbooks`, `/monitors`, `/charts` | `get_playbook`, `save_playbook`, `save_monitor`, `save_chart` | [MCP tools](https://docs.allocait.app/claude/tools.md) |

## Events, preferences and feedback

| Task | Route | MCP tool | Guide |
| - | - | - | - |
| Subscribe to compliance events | `/webhooks` | none | [Webhooks](https://docs.allocait.app/guides/webhooks.md) |
| Read or set display preferences | `GET` and `POST /preferences` | none | none |
| File support requests and feedback | `/support-requests`, `/agent-feedback` | `send_feedback` | [Send feedback](https://docs.allocait.app/guides/send-feedback.md) |

## Related

* [API overview](https://docs.allocait.app/api/introduction.md)
* [API quickstart](https://docs.allocait.app/api/quickstart.md)
* [Conventions](https://docs.allocait.app/api/conventions.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.