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

# Endpoint index

> Find every customer-facing PAMM route by resource and purpose.

## Masters

| Method | Endpoint | Purpose |
| - | - | - |
| `GET` | `/api/v1/master/directory` | List PAMM Masters using `page` and `limit`. |
| `POST` | `/api/v1/master/add` | Register existing Master and payment accounts. |
| `POST` | `/api/v1/master/create` | Create a Master and payment account in MT5. |
| `GET` | `/api/v1/master/{master_id}` | Retrieve a Master by internal PAMM ID. |
| `PATCH` | `/api/v1/master/{master_id}` | Update exposed Master fields. |
| `GET` | `/api/v1/info/master/{master_login}` | Retrieve sensitive Master details by MT5 login. |

## Investors and funds

| Method | Endpoint | Purpose |
| - | - | - |
| `GET` | `/api/v1/investor/directory` | List PAMM Investors using `page` and `limit`. |
| `POST` | `/api/v1/investor/add` | Register an existing Investor account. |
| `POST` | `/api/v1/investor/create` | Create an Investor account in MT5. |
| `PATCH` | `/api/v1/investor/{investor_id}` | Update the local Investor alias by internal ID. |
| `GET` | `/api/v1/info/investor/{investor_login}` | Retrieve sensitive Investor details. |
| `POST` | `/api/v1/investor/deposit` | Credit Investor capital. |
| `POST` | `/api/v1/investor/withdraw` | Process pending fees and withdraw capital. |
| `GET` | `/api/v1/info/balance/{mt5_login}` | Retrieve an MT5 balance. |

## Subscriptions

| Method | Endpoint | Purpose |
| - | - | - |
| `POST` | `/api/v1/investor/assign` | Subscribe an Investor to a Master. |
| `POST` | `/api/v1/subscriptions/unassign` | End a subscription in a controlled process. |
| `GET` | `/api/v1/info/subscriptions` | List and filter subscriptions. |
| `GET` | `/api/v1/info/master/{master_login}/investors` | List active Investors for a Master. |
| `GET` | `/api/v1/info/investor/{investor_login}/master` | Resolve an Investor's active Master. |

## Performance fees

| Method | Endpoint | Purpose |
| - | - | - |
| `GET` | `/api/v1/investor/{investor_login}/performance-fee` | Read one Investor's fee configuration. |
| `POST` | `/api/v1/investor/perf-fee/update` | Update an Investor's fee configuration. |
| `GET` | `/api/v1/perf-fee/transactions` | List credits received by a Master's payment account. |
| `GET` | `/api/v1/perf-fee/master/{master_login}/investor-payments` | List executed fees by Investor. |

> [card] [Previous: API conventions](https://pamm-api.exuratech.com/reference/conventions.md)
>
> Review request and pagination rules.

> [card] [Next: Master endpoints](https://pamm-api.exuratech.com/reference/masters.md)
>
> Open the complete Master contracts.


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