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

# Allocations

> Eligibility and lifecycle endpoints for a copy-trading relationship.

| Method | Path | Purpose |
| - | - | - |
| `GET` | `/api/v1/mam/allocations` | Lists by leader, follower, or status. |
| `GET` | `/api/v1/mam/allocations/events` | Reads incremental changes after `after_id`. |
| `POST` | `/api/v1/mam/allocations/subscription-eligibility` | Validates the minimum deposit without creating resources. |
| `POST` | `/api/v1/mam/allocations` | Creates a relationship between two accounts. |
| `GET` | `/api/v1/mam/allocations/{allocation_id}` | Retrieves configuration and status. |
| `PATCH` | `/api/v1/mam/allocations/{allocation_id}` | Updates the sent fields. |
| `POST` | `/api/v1/mam/allocations/{allocation_id}/unsubscribe` | Starts termination with the configured policy. |

## Creation fields

| Field | Integration note |
| - | - |
| `leader_login` | Account that originates trades. |
| `follower_login` | Account that receives trades; it must be different. |
| `status` | Creating in `PAUSED` and activating after validating the response is recommended. |
| `allocation_mode` | `FIXED`, `SCALED`, `EQUITY`, `EQUITY_ROUND_DOWN`, or `BALANCE`. |
| `mode_parameter` | Required for `FIXED` and `SCALED`; always greater than `0` when sent. |
| `equity_stop` | Threshold in equity units; `null` disables it. |
| `unsubscribe_policy` | `KEEP_OPEN` or `CLOSE_ON_UNSUBSCRIBE`. |
| `performance_fee_rate` | `null` inherits the leader rate at creation time. |
| `max_active_leaders_per_follower` | Limit calculated by the integrator's product for this request. |

> [!NOTE]
>
> Agent callback and internal equity-stop control endpoints are not part of this integration reference.

## Event feed

`GET /allocations/events` accepts `after_id` (default `0`) and `limit` from `1` to `1000`. It returns `items`, `next_cursor`, and `has_more`. Process events in ascending order and retain the last confirmed ID so that processing can continue after an interruption.


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