# Endpoint availability

> Every endpoint in these docs and whether it answers today — generated from the same catalogue every page reads its badge from.

Source: https://www.propexecutor.com/docs/availability
Whole reference in one file: https://www.propexecutor.com/doc.md

These docs describe the full surface a prop firm needs, which is more than is built today. This page is the honest index: what answers right now, and what is designed and documented but not yet shipped.

| Status | Count | Means |
| --- | --- | --- |
| Available | **16** | Live in production. Safe to build against now. |
| Planned | **34** | Documented and designed. Returns 404 today. |

> **Why document what is not built**
> Two reasons. A firm deciding whether to buy needs to see the whole shape rather than guess at it, and a firm building against it needs the contract settled before the handler exists so the integration and the endpoint can be written in either order.
> 
> What we will not do is let the two drift. Every signature on every page reads its badge from the same catalogue this table is built from, so a page cannot quietly claim something is live.

## Trading accounts

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Live | `GET /v1/accounts` | `accounts:read` | List trading accounts, newest first. |
| Live | `GET /v1/accounts/{account}` | `accounts:read` | One account with live balance, equity and open positions. |
| Planned | `POST /v1/accounts` | `accounts:write` | Provision one or more accounts. Spends account credits. |
| Live | `PUT /v1/accounts/{account}/trader` | `accounts:write` | Assign an account to a trader by name and email, creating the trader if needed. |
| Live | `DELETE /v1/accounts/{account}/trader` | `accounts:write` | Take an account back off its holder. Revokes its sessions. |
| Planned | `POST /v1/accounts/{account}/archive` | `accounts:write` | Take an account out of circulation and revoke its sessions. |
| Live | `GET /v1/accounts/{account}/trades` | `accounts:read` | Full trade history, open and closed, cursor-paginated. |
| Live | `GET /v1/accounts/{account}/positions` | `accounts:read` | Open positions only, marked to the latest price. |
| Live | `GET /v1/accounts/{account}/orders` | `accounts:read` | Resting orders — limits and stops that have not triggered. |
| Live | `GET /v1/accounts/{account}/rule-flags` | `accounts:read` | Rules the account tripped that flag rather than breach. |
| Planned | `POST /v1/accounts/{account}/breach` | `trading:write` | Force a breach for a violation caught outside the platform. |
| Planned | `POST /v1/accounts/{account}/positions` | `trading:write` | Open a position on an account's behalf. |
| Planned | `DELETE /v1/accounts/{account}/positions/{id}` | `trading:write` | Close an open position. |

## Credentials

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Live | `GET /v1/accounts/{account}/credentials` | `credentials:read` | The Account Number / Server / Password a trader signs in with. |
| Live | `POST /v1/accounts/{account}/credentials/rotate` | `credentials:read` | Generate a new password and end every live session. |

## Traders

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/traders` | `accounts:read` | List trader records. |
| Planned | `POST /v1/traders` | `accounts:write` | Create a trader record. Sends nothing and grants no login. |
| Planned | `GET /v1/traders/{id}` | `accounts:read` | One trader with the accounts they hold. |
| Planned | `PATCH /v1/traders/{id}` | `accounts:write` | Correct a trader's name or email. |
| Planned | `GET /v1/traders/{id}/summary` | `accounts:read` | Aggregate performance across every account this trader holds. |

## Account types

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/account-types` | `accounts:read` | The challenges you sell, with their balances and rule sets. |
| Planned | `POST /v1/account-types` | `accounts:write` | Create a challenge tier pointing at a rule set. |
| Planned | `PATCH /v1/account-types/{id}` | `accounts:write` | Rename or reprice a challenge. Existing accounts are unaffected. |

## Rule sets

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/rule-sets` | `accounts:read` | List rule sets and their current version. |
| Planned | `POST /v1/rule-sets` | `accounts:write` | Create a rule set. |
| Planned | `GET /v1/rule-sets/{id}/versions` | `accounts:read` | Every version of a rule set, newest first. |
| Planned | `POST /v1/rule-sets/{id}/versions` | `accounts:write` | Append a new version. Never edits an existing one. |
| Planned | `GET /v1/rule-catalog` | `accounts:read` | Every rule you can build with, and which your tier unlocks. |

## Analytics

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Live | `GET /v1/accounts/{account}/analytics` | `accounts:read` | One account's whole performance picture in a single response. |
| Live | `GET /v1/accounts/{account}/equity` | `accounts:read` | The balance and equity series behind the chart. |
| Live | `GET /v1/accounts/{account}/report` | `accounts:read` | The whole account in one response — deals and evaluation terms included. |

## Reporting

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/reports/overview` | `accounts:read` | Firm-wide counts, pass rate and net P&L across every account. |
| Planned | `GET /v1/reports/leaderboard` | `accounts:read` | Accounts ranked by gain, drawdown or profit factor. |
| Planned | `GET /v1/reports/decisions` | `accounts:read` | A feed of breaches and passes, newest first. |

## Market data

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/instruments` | `accounts:read` | Tradeable symbols with their asset class and leverage. |
| Planned | `GET /v1/prices` | `accounts:read` | Latest bid/ask for one or more instruments. |
| Planned | `GET /v1/candles` | `accounts:read` | OHLC history for an instrument, back to 2000 where we have it. |

## Billing

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/credits` | `accounts:read` | Granted, used and remaining account credits, with your tier. |
| Planned | `GET /v1/credits/ledger` | `accounts:read` | Every grant and debit that moved your balance. |
| Planned | `GET /v1/purchases` | `accounts:read` | Your plan, pack and upgrade purchases. |

## Branding

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/branding` | `accounts:read` | How your executor currently looks. |
| Planned | `PUT /v1/branding` | `accounts:write` | Update logos, colours and the login screen. Tier-gated. |

## Webhooks

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Planned | `GET /v1/webhooks` | `accounts:read` | List your webhook endpoints. |
| Planned | `POST /v1/webhooks` | `accounts:write` | Register a URL and get its signing secret. |
| Planned | `DELETE /v1/webhooks/{id}` | `accounts:write` | Stop delivering to an endpoint. |
| Planned | `GET /v1/webhooks/{id}/deliveries` | `accounts:read` | Delivery attempts and their outcomes, for debugging. |
| Planned | `POST /v1/webhooks/{id}/test` | `accounts:write` | Send a signed test event so you can verify your handler. |

## API keys

|  | Endpoint | Scope | What it does |
| --- | --- | --- | --- |
| Live | `GET /api-keys` | `panel` | List your organization's API keys. |
| Live | `POST /api-keys` | `panel` | Issue a key. The token is returned once. |
| Live | `POST /api-keys/{id}/revoke` | `panel` | Revoke a key immediately. |

## Webhook events

Every event below is a decision the platform already makes internally — the rule engine writes a breach before it returns, and the executor is already told over an internal bus. Delivering them to you is a fan-out of existing behaviour, not new behaviour.

|  | Event |
| --- | --- |
| Planned | `account.breached` |
| Planned | `account.passed` |
| Planned | `account.flagged` |
| Planned | `account.created` |
| Planned | `account.assigned` |
| Planned | `account.archived` |
| Planned | `position.opened` |
| Planned | `position.closed` |
| Planned | `order.rejected` |
| Planned | `credits.low` |

## Need one sooner

Priority follows what customers actually block on. If a planned endpoint is what stands between you and shipping, say so — [book a call](https://www.propexecutor.com/consultation) or email [info@propexecutor.com](mailto:info@propexecutor.com) — and it moves up.