> ## 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. # Real-time event stream (WebSocket) > Live push of the **same events and payloads** your webhooks receive, over a plain WebSocket. Use it for dashboards, monitoring, or low-latency reactions without hosting a public HTTPS endpoint. **Connect** (same API key as the REST API — no separate credentials): ```javascript const WebSocket = require('ws'); const ws = new WebSocket( 'wss://api.hyperprop.com/platform/v1/organization/events/stream', { headers: { 'X-API-Key': 'hp_live_...' } } ); ws.on('message', (raw) => { const frame = JSON.parse(raw); if (frame.type === 'event') { // frame.event is byte-for-byte the same JSON body a webhook POST carries: // { id, type, createdAt, organizationId, data, previousAttributes, ... } console.log(frame.event.type, frame.event.data.accountNumber); } }); ``` Clients that cannot set headers may pass `?api_key=hp_live_...` in the URL instead. **Frames you receive:** | Frame | Meaning | |-------|---------| | `{ "type": "connected", "organizationId", "serverTime" }` | Sent once after a successful connect | | `{ "type": "event", "event": { ... } }` | A live event — `event` matches the webhook payload schema exactly | | `{ "type": "event.replay", ... }` | Slim catch-up event when you connect with `?since=` (id, eventType, accountId, reason, createdAt) | | `{ "type": "replay.complete", "count", "truncated" }` | Catch-up finished; `truncated: true` means more than 1000 events matched — reconnect with a later `since` | | `{ "type": "pong" }` | Reply to your `{ "type": "ping" }` | **Catch-up after a disconnect:** reconnect with `?since=` (e.g. `?since=2026-07-21T10:00:00Z`) to receive slim replays of events you missed, oldest first, then live events resume. Replay frames carry identifiers only — fetch full account state via `GET /platform/v1/organization/trading-accounts/{id}` if needed. **Delivery guarantees:** the stream is a live, best-effort channel. Webhooks remain the guaranteed channel with retries, HMAC signing, and redelivery — keep them registered for anything money-critical and treat the stream as the low-latency mirror. **Keep-alive:** the server pings every 30 seconds; standard WebSocket libraries answer automatically. Idle connections that miss pongs are dropped. You may also send `{"type":"ping"}` and receive `{"type":"pong"}`. **Limits:** maximum 10 concurrent stream connections per organization. **Authentication:** two modes are accepted: - **API key** — `X-API-Key: hp_live_...` header (preferred for server integrations) or `?api_key=` query parameter. - **Member session** — `Authorization: Bearer ` header or `?token=` query parameter (browsers cannot set WebSocket headers). Any active member of the organization may subscribe; this is what powers the real-time admin portal. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/events/stream openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. ## Authentication Two methods, depending on who is calling: ### Bearer Token (JWT) — users & dashboard Most endpoints accept a JWT via `Authorization: Bearer `. Used by the dashboard and client applications. ### API Key — organizations (prop firms) Organization endpoints also accept `X-API-Key: hp_live_...` for programmatic access from your backend — no browser session needed. Keys are managed by organization admins in the dashboard; each key carries permissions (`read`, `write`, `admin`) and can be rotated or revoked at any time. Keys are stored hashed (SHA-256) — the raw key is shown once at creation. Endpoints that create or modify data require `write` or `admin`. ## Quick Start ```bash # 1. List your trading plans (grab a tradingPlanId) curl "https://api.hyperprop.com/platform/v1/organization/trading-plans" \ -H "X-API-Key: hp_live_your_key_here" # 2. Create a trading account for a trader (by Hyperprop user ID or email) curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "", "email": "trader@example.com"}' ``` ## Response Envelope & Error Handling **Success** responses always wrap the payload: ```json { "success": true, "data": { ... }, "message": "optional human-readable note" } ``` **Errors** — including request-validation failures, auth failures, and errors proxied from the trade engine — always return this single uniform shape with a machine-readable `code` you can switch on: ```json { "success": false, "statusCode": 404, "error": "Not Found", "message": "No Hyperprop user found with that email. The trader must have a Hyperprop account before an account can be created for them.", "code": "TRADER_NOT_FOUND" } ``` Parse rule of thumb: check `success`; on `false`, switch on `code` (never on `message` text — messages can be reworded). Some errors carry additional structured context alongside these fields (e.g. payout rejections include a `consistency` block). Common codes: `VALIDATION_ERROR` (malformed payload/params), `UNAUTHORIZED`, `INSUFFICIENT_PERMISSIONS` / `NOT_ADMIN` (key lacks write/admin), `*_NOT_FOUND` (missing resource), `*_NOT_IN_ORG` (resource belongs to another organization), `IDEMPOTENCY_KEY_IN_PROGRESS` (duplicate in flight), `ENGINE_UNREACHABLE` (trade engine down — retry with the same idempotency key). Endpoint-specific codes (e.g. payout `OPEN_EXPOSURE`, `CONSISTENCY_BLOCKED`) are documented on each endpoint. ## Idempotency **Every mutating endpoint (POST, PUT, PATCH, DELETE) honors idempotency keys uniformly.** Send an `Idempotency-Key` header (the `X-Idempotency-Key` spelling is accepted as an alias) to retry any write safely without creating duplicates. How it works: - The key is scoped to your organization + the request path. The first request with a given key executes normally and its response is cached for **24 hours**. - A replay (same key, same path) within 24 hours returns the cached response with an `Idempotency-Replayed: true` response header — the operation is **not** executed again. - If a request with the same key is still in flight, the duplicate gets `409 IDEMPOTENCY_KEY_IN_PROGRESS` — back off and retry; you'll then receive the cached response. - 5xx responses are **not** cached, so retrying after a server error re-executes the request (that's what you want). 2xx-4xx responses are cached — if a request failed validation and you fix the payload, use a **fresh key**. - Keys are free-form strings up to 255 characters. Use something that identifies the operation on your side, e.g. `order-8814-attempt-1`. ```bash curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Idempotency-Key: order-8814-attempt-1" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "...", "traderId": "..."}' ``` This applies to account creation, account PATCH (status, currentBalance, metadata), rules, plans, lockouts, payouts, team, webhooks — every write on the platform API. Payouts additionally forward the key to the trade engine for engine-level double-withdrawal protection. ## Pagination & Sorting List endpoints support both styles: - **Cursor (recommended):** pass `?cursor=` from the previous response's `pagination.nextCursor`. Stable under concurrent writes. - **Offset:** `?limit=&offset=` with `pagination.total` / `hasMore` in the response. Sorting uses `?sort=field:direction` (e.g. `?sort=created_at:asc`); allowed fields are listed per endpoint. Default: `created_at:desc`. ## Custom Metadata Trading accounts, purchases, traders, plans, and rules all carry a free-form `metadata` JSON object. Use it to store your own references — payment IDs, campaign tags, payout records, internal notes. Hyperprop stores and returns it verbatim (and lets you filter list endpoints by it, e.g. `?metadata=stripePaymentId:pi_123`) but never interprets it. Update endpoints support `mergeMetadata: true` for shallow (top-level) merges instead of wholesale replacement. ## Webhooks Subscribe to account lifecycle events (`account.created`, `account.status_changed`, `account.updated`, `account.passed`, `account.failed`, and more) via the Webhooks endpoints. Deliveries are HMAC-SHA256 signed — verify `X-Hyperprop-Signature` with your endpoint secret, using `X-Hyperprop-Timestamp` for replay protection; `X-Hyperprop-Delivery` gives you a unique delivery ID for deduplication. Failed deliveries are retried with backoff, and you can redeliver any event from the dashboard or API. ## MCP Connector (AI Agents) The platform ships a built-in [MCP](https://modelcontextprotocol.io) server, so AI agents and assistants (Claude, Cursor, custom agents) can operate your organization directly — no integration code required. ```http Endpoint: POST https://api.hyperprop.com/platform/v1/mcp Transport: Streamable HTTP (stateless, JSON responses) Auth: X-API-Key header, Authorization: Bearer hp_live_..., or OAuth ``` **Claude web / desktop (Add custom connector):** paste the endpoint URL and leave the OAuth Client ID/Secret fields empty — the connector registers itself automatically. Claude opens a Hyperprop consent page where an org admin pastes the organization API key once; access then follows that key's permissions and ends if the key is revoked. (Under the hood: OAuth 2.1 with PKCE and dynamic client registration.) **Cursor / Claude Code — `mcp.json`:** ```json { "mcpServers": { "hyperprop": { "url": "https://api.hyperprop.com/platform/v1/mcp", "headers": { "X-API-Key": "hp_live_your_key_here" } } } } ``` **Available tools (12):** `list_trading_plans`, `list_trading_accounts`, `get_trading_account`, `get_account_audit_log`, `list_traders`, `get_trader`, `list_purchases`, `get_purchase`, `get_billing_summary` (read) · `create_trading_account`, `update_trading_account`, `record_payout` (write). Every tool call executes the corresponding REST endpoint with your key, so organization scoping, permissions, validation, audit logging, and webhooks apply exactly as documented on each endpoint. Read tools work with any key; write tools need `write`/`admin` permission — connect a **read-only key** if you want a strictly read-only agent. `create_trading_account` accepts an optional `idempotencyKey` so agent retries can't create duplicates, and `record_payout` implements the documented payout recipe (append to `metadata.payouts`, adjust `currentBalance`, audit-logged `reason`). ## Endpoint Groups - **Authentication** — Sign up, sign in, OAuth, MFA, password reset. No auth required for most. - **User** — Profile, notifications, demo accounts, audit logs. Requires **Bearer token** (JWT). - **Organization** — Trading accounts, plans, rules, traders, purchases, lockouts, billing, bulk operations, webhooks, analytics. Accepts **Bearer token** OR **API Key**. - **System** — Health checks. No auth required. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Authentication description: >- User authentication - signup, signin, signout, password reset, email verification, OAuth, and MFA - name: User description: >- User account management - profile, notifications, agreements, dismissals, and audit logs. Requires Bearer token. - name: Organization description: >- Organization management - profile, team, trading accounts, plans, and rules. Supports **dual authentication**: Bearer JWT token (dashboard users) OR X-API-Key (programmatic access). - name: Demo description: >- Demo account management - import, list, and delete demo trading accounts. Requires Bearer token. - name: Market Data description: CME futures contracts and market data. Requires Bearer token. - name: System description: System endpoints - health checks and connectivity paths: /v1/organization/events/stream: get: tags: - Organization summary: Real-time event stream (WebSocket) description: >- Live push of the **same events and payloads** your webhooks receive, over a plain WebSocket. Use it for dashboards, monitoring, or low-latency reactions without hosting a public HTTPS endpoint. **Connect** (same API key as the REST API — no separate credentials): ```javascript const WebSocket = require('ws'); const ws = new WebSocket( 'wss://api.hyperprop.com/platform/v1/organization/events/stream', { headers: { 'X-API-Key': 'hp_live_...' } } ); ws.on('message', (raw) => { const frame = JSON.parse(raw); if (frame.type === 'event') { // frame.event is byte-for-byte the same JSON body a webhook POST carries: // { id, type, createdAt, organizationId, data, previousAttributes, ... } console.log(frame.event.type, frame.event.data.accountNumber); } }); ``` Clients that cannot set headers may pass `?api_key=hp_live_...` in the URL instead. **Frames you receive:** | Frame | Meaning | |-------|---------| | `{ "type": "connected", "organizationId", "serverTime" }` | Sent once after a successful connect | | `{ "type": "event", "event": { ... } }` | A live event — `event` matches the webhook payload schema exactly | | `{ "type": "event.replay", ... }` | Slim catch-up event when you connect with `?since=` (id, eventType, accountId, reason, createdAt) | | `{ "type": "replay.complete", "count", "truncated" }` | Catch-up finished; `truncated: true` means more than 1000 events matched — reconnect with a later `since` | | `{ "type": "pong" }` | Reply to your `{ "type": "ping" }` | **Catch-up after a disconnect:** reconnect with `?since=` (e.g. `?since=2026-07-21T10:00:00Z`) to receive slim replays of events you missed, oldest first, then live events resume. Replay frames carry identifiers only — fetch full account state via `GET /platform/v1/organization/trading-accounts/{id}` if needed. **Delivery guarantees:** the stream is a live, best-effort channel. Webhooks remain the guaranteed channel with retries, HMAC signing, and redelivery — keep them registered for anything money-critical and treat the stream as the low-latency mirror. **Keep-alive:** the server pings every 30 seconds; standard WebSocket libraries answer automatically. Idle connections that miss pongs are dropped. You may also send `{"type":"ping"}` and receive `{"type":"pong"}`. **Limits:** maximum 10 concurrent stream connections per organization. **Authentication:** two modes are accepted: - **API key** — `X-API-Key: hp_live_...` header (preferred for server integrations) or `?api_key=` query parameter. - **Member session** — `Authorization: Bearer ` header or `?token=` query parameter (browsers cannot set WebSocket headers). Any active member of the organization may subscribe; this is what powers the real-time admin portal. operationId: getV1OrganizationEventsStream responses: '101': description: >- Switching Protocols — the WebSocket handshake succeeded. The first frame is `{ "type": "connected", "organizationId", "serverTime" }`, then `event` frames follow (see notes for the full frame table). '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model7' '426': description: >- Returned to plain HTTP GETs — connect with a WebSocket client instead content: '*/*': schema: $ref: '#/components/schemas/Model230' '429': description: >- Too many concurrent stream connections for this organization (max 10) content: '*/*': schema: $ref: '#/components/schemas/Model231' security: - Bearer: [] - X-API-Key: [] components: schemas: Model7: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model230: type: object properties: success: type: boolean example: false error: $ref: '#/components/schemas/error' Model231: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 429 error: type: string example: Too Many Requests message: type: string example: Maximum 10 concurrent stream connections per organization code: type: string description: Machine-readable error code — switch on this, not on message text example: TOO_MANY_CONNECTIONS error: type: object properties: code: type: string example: UPGRADE_REQUIRED message: type: string example: This endpoint is a WebSocket. Connect with a WebSocket client. securitySchemes: Bearer: type: apiKey name: Authorization in: header description: >- JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints. X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key for programmatic access. Format: "hp_live_{key}". Used by Organization endpoints as an alternative to Bearer token. Keys are managed in the dashboard. ```` ## Related topics - [WebSocket Stream (Documentation Only)](/market-data-api/websocket/websocket-stream-documentation-only.md) - [Real-time WebSocket for trading events](/trade-api/websocket/real-time-websocket-for-trading-events.md) - [Get open positions with real-time P&L](/trade-api/positions/get-open-positions-with-real-time-p&l.md) - [Rate limits & quotas](/concepts/rate-limits.md) - [Register a webhook endpoint](/platform-api/organization/register-a-webhook-endpoint.md)