> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Introduction
> REST API for the Hyperprop trading platform — built for prop firms integrating from their own backend.
The Hyperprop Platform API lets your firm provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing — all programmatically, from your own backend.
Create your first trading account in three requests.
API keys for your backend, Bearer tokens for user sessions.
Signed account lifecycle events, with retries and redelivery.
Trade on behalf of a trader with a key they control.
Platform, Trade, and Market Data — each generated from its live OpenAPI spec.
## Services & base URLs
Hyperprop is three services behind one domain. Each has its own base URL, its own auth model, and its own reference tab in these docs:
| Service | Base URL | Auth | Browser access |
| ---------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| **Platform API** | `https://api.hyperprop.com/platform` | `X-API-Key` (org key) or Bearer JWT | Organization endpoints: any origin. User endpoints: Hyperprop apps only |
| **Trade API** | `https://api.hyperprop.com/trade` | Bearer JWT (trader session), or a partner session from `POST /trade/partner/session` | Hyperprop apps + approved origins only |
| **Market Data** | `https://api.hyperprop.com/md` | Bearer JWT — requires the accepted CME agreement and active market-data entitlements | Hyperprop apps + approved origins only |
* The **Platform API** is the firm-facing control plane: accounts, plans, rules, traders, billing, webhooks. This is where prop firm backends live.
* The **Trade API** is the trading engine itself: orders, positions, brackets, risk settings, copy trading. Called on behalf of a trader — either by Hyperprop's own apps, or by a registered third-party app using a [partner session](/guides/partner-integrations).
* **Market Data** serves CME futures data: historical OHLC, order book snapshots, tickers.
All documented paths in each tab are relative to that service's base — for example `GET /v1/organization/trading-accounts` on the Platform API is `https://api.hyperprop.com/platform/v1/organization/trading-accounts`.
### Browser access policy
This section is about **where a request may originate from in a browser** — it
is not a statement about who may integrate. Server-to-server access to every
service below is available through the documented auth methods.
CORS and WebSocket origins are restricted as follows:
* **Open to any web origin:** Platform API organization endpoints, MCP, and
these docs' specs. Call them from your backend or your own dashboard
freely.
* **Hyperprop first-party only:** the Trade API, the Market Data API, and
the Platform API's user-scoped endpoints (profile, auth, demo accounts).
Browsers can call these only from Hyperprop's own apps.
This only affects **browsers** — server-to-server calls and native apps
don't send an `Origin` header and are unaffected. A registered partner app
calling the Trade API from its own backend is unaffected by this policy; see
[Partner integrations](/guides/partner-integrations). Building a
trader-facing web frontend that needs direct Trade API or Market Data
access? Contact us to have your origin approved; it's a configuration
change, not a code change, on our side.
### Real-time channels
| Stream | URL | Auth | Browser access |
| ------------------------------------------------ | ---------------------------------------------------------------- | --------------------------------- | --------------------------------- |
| Trade events (fills, positions, account updates) | `wss://api.hyperprop.com/trade/ws` | JWT via `?token=` | Hyperprop apps + approved origins |
| Market data (ticks, OHLC, order book) | `wss://api.hyperprop.com/md/ws/stream` | JWT via `?token=` | Hyperprop apps + approved origins |
| Organization event stream (webhook mirror) | `wss://api.hyperprop.com/platform/v1/organization/events/stream` | `X-API-Key` header or `?api_key=` | Any origin |
## Platform API endpoint groups
| Group | What it covers | Auth |
| ------------------ | -------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| **Organization** | Trading accounts, plans, rules, traders, purchases, lockouts, payouts, billing, bulk operations, webhooks, analytics | API key or Bearer token |
| **Authentication** | Sign up, sign in, OAuth, MFA, password reset | Mostly public |
| **User** | Profile, notifications, demo accounts, audit logs | Bearer token |
| **System** | Health checks | Public |
As a prop firm integrating from a backend, you will spend nearly all of your time in the **Organization** group with an [API key](/authentication).
## How the pieces fit
1. **Plans** define what you sell (starting balance, price metadata).
2. **Rules** define how an account is evaluated (loss limits, drawdown mode, profit target, consistency, permissions).
3. **Trading accounts** are instances of a plan+rule assigned to a **trader**.
4. The trade engine enforces the rules in real time; when an account passes, fails, or changes in any way you care about, a [webhook](/guides/webhooks) tells your backend.
5. **Purchases**, **payouts**, and **billing** endpoints close the loop for reconciliation.
## AI agents
The platform ships a built-in MCP server so AI assistants can operate your organization through the same API, with the same permissions and audit logging. See the [MCP connector guide](/guides/mcp-connector).