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

# Overview

> Submit, inspect, and measure broker-agnostic trading intents.

## Availability

Intent management is available on all plans.

## Intended Purpose

Intents provide a broker-agnostic interface for submitting trading actions through Anthid.

Instead of integrating directly with broker-specific order entry APIs, applications submit intents describing the desired trading action. Anthid validates, routes, tracks, and executes those requests through the appropriate broker integration while exposing a consistent platform interface.

This allows applications to integrate once and operate across supported brokers without implementing broker-specific order submission logic.

## Access

Submitting intents is authorized for API-key callers that belong to the account organization and have organization intent edit permission. Create intents on live accounts additionally require the Trading Live entitlement and must pass controls evaluation before an action and outbox record are written.

Read operations require intent read access. Service-account callers must provide `x-organization-id` and have `intent:read`; API-key callers need organization intent read permission; user callers need an organization admin, member, or read-only role. Non-service callers can only read their principal organization.

## Intent Commands

The submit endpoint appends an intent command for a trading account:

| Command   | Purpose                                                                           |
| --------- | --------------------------------------------------------------------------------- |
| `CREATE`  | Start a new intent lineage for a market, limit, stop, or stop-limit order         |
| `REPLACE` | Append a replacement action for an existing intent referenced by `ref_intent_id`  |
| `CANCEL`  | Append a cancellation action for an existing intent referenced by `ref_intent_id` |

Create commands include a symbol, order side, optional route strategy, and order spec. Replace commands include a replacement order spec. Cancel commands only require the referenced intent id.

## Endpoint Groups

| Group           | Endpoints                                                   |
| --------------- | ----------------------------------------------------------- |
| Submit and list | `GET` and `POST /v1/accounts/{account_id}/intents`          |
| Stats           | `GET /v1/accounts/{account_id}/intents/stats`               |
| Latest action   | `GET /v1/accounts/{account_id}/intents/{intent_id}`         |
| Action history  | `GET /v1/accounts/{account_id}/intents/{intent_id}/actions` |

List endpoints return append-only action records in ascending order and support `next_cursor` and `limit`. Stats support `time_window` with `last_day` as the default when omitted.

## Common Use Cases

* Submit market, limit, stop, and stop-limit orders.
* Build automated trading systems using a unified API.
* Route orders through platform controls and risk checks.
* Track order execution through a consistent lifecycle.
* Support multiple brokers without maintaining separate integrations.
* Create trading workflows that operate across paper and live environments.
* Generate auditable records of trading activity.

## Lifecycle

An intent represents a requested trading action.

After submission, Anthid validates the request, evaluates applicable controls, appends an action record, queues broker execution, and tracks execution status throughout its lifecycle.

Applications can monitor intent activity using:

* Intent action history
* Intent stats
* Streaming API
* Ledger APIs

## Common Workflow

1. Create a Trading Account.
2. Submit an Intent.
3. Anthid validates and processes the request.
4. The request is routed to the broker.
5. Order updates are streamed through the Streaming API.
6. Historical activity becomes available through the Ledger APIs.

## Related Resources

* Trading Accounts
* Brokers
* Orders
* Positions
* Ledger
* Streaming API
* Controls

## Support

For questions about authentication, request formats, or API behavior, contact [support@anthid.com](mailto:support@anthid.com).
