> ## 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. # Get active status notices > Status notices shown as a banner above the app navigation and listed in full on the public status page. **No authentication required.** ## Severity Several notices can be active at once. The array is sorted most severe first, then by `priority`, then newest — so a client renders element `[0]` as its single banner and never has to sort. The status page renders the whole array. | Severity | Meaning | |---|---| | `info` | Informational, no trading impact (migration, release, maintenance) | | `warning` | Degraded conditions — trading is discouraged | | `critical` | Do not open positions — close-only, or trading halted | `priority` only breaks ties within one severity. A `critical` notice always outranks a `warning`, whatever their priorities. ## Fields `message` is the one-line banner text. `title` and `description` are the longer form used on the status page; `title` falls back to `message` when null. `effectiveAt` is when the notice took effect (its scheduled start, or when it was created) — that is the timestamp to show a user. ## Scheduling Only rows that are `active` AND inside their window are returned. `startsAt` in the future or `endsAt` in the past excludes a row; null on either side means unbounded. The window is evaluated server-side, so a maintenance notice can be scheduled once and left alone. ## Dismissing When `dismissible` is true, send the returned `dismissalKey` to `POST /platform/v1/user/dismissals` and stop rendering that notice for the user (that endpoint does require a session). The key is built server-side (`ann:`) so the two cannot drift apart, and it fits the 50-character limit that endpoint validates. Incident notices are typically created with `dismissible: false` so a trader cannot hide a close-only warning. ## Colours `backgroundColor` and `textColor` are optional overrides. Leave them null — the normal case — and the client styles from `severity`, which stays legible in both light and dark mode. Only set them for a deliberate one-off. ```bash curl "https://api.hyperprop.com/platform/v1/announcements" ``` ## OpenAPI ````yaml /api-reference/openapi.json get /v1/announcements 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/announcements: get: tags: - User summary: Get active status notices description: >- Status notices shown as a banner above the app navigation and listed in full on the public status page. **No authentication required.** ## Severity Several notices can be active at once. The array is sorted most severe first, then by `priority`, then newest — so a client renders element `[0]` as its single banner and never has to sort. The status page renders the whole array. | Severity | Meaning | |---|---| | `info` | Informational, no trading impact (migration, release, maintenance) | | `warning` | Degraded conditions — trading is discouraged | | `critical` | Do not open positions — close-only, or trading halted | `priority` only breaks ties within one severity. A `critical` notice always outranks a `warning`, whatever their priorities. ## Fields `message` is the one-line banner text. `title` and `description` are the longer form used on the status page; `title` falls back to `message` when null. `effectiveAt` is when the notice took effect (its scheduled start, or when it was created) — that is the timestamp to show a user. ## Scheduling Only rows that are `active` AND inside their window are returned. `startsAt` in the future or `endsAt` in the past excludes a row; null on either side means unbounded. The window is evaluated server-side, so a maintenance notice can be scheduled once and left alone. ## Dismissing When `dismissible` is true, send the returned `dismissalKey` to `POST /platform/v1/user/dismissals` and stop rendering that notice for the user (that endpoint does require a session). The key is built server-side (`ann:`) so the two cannot drift apart, and it fits the 50-character limit that endpoint validates. Incident notices are typically created with `dismissible: false` so a trader cannot hide a close-only warning. ## Colours `backgroundColor` and `textColor` are optional overrides. Leave them null — the normal case — and the client styles from `severity`, which stays legible in both light and dark mode. Only set them for a deliberate one-off. ```bash curl "https://api.hyperprop.com/platform/v1/announcements" ``` operationId: getV1Announcements responses: '200': description: Active status notices retrieved successfully content: '*/*': schema: $ref: '#/components/schemas/Model2' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model3' components: schemas: Model2: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/data' Model3: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR data: type: object properties: announcements: $ref: '#/components/schemas/announcements' announcements: type: array items: $ref: '#/components/schemas/Model1' Model1: type: object properties: id: type: string example: 8f14e45f-ceea-467a-9a1c-2b3f4d5e6a7b message: type: string example: 'Close-only: do not open new positions.' severity: $ref: '#/components/schemas/severity' title: type: string description: Status-page heading; falls back to message when null example: Close-only mode description: type: string description: Long-form body for the status page example: >- Because of a platform issue we are asking traders not to open new positions. You can still close or reduce existing positions. effectiveAt: type: string description: When the notice took effect (startsAt, else createdAt) example: '2026-07-28T14:02:00.000Z' startsAt: type: string example: null endsAt: type: string example: null updatedAt: type: string example: '2026-07-28T14:02:00.000Z' backgroundColor: type: string description: Optional CSS colour override; null styles from severity example: null textColor: type: string example: null linkUrl: type: string description: Optional "learn more" target example: null linkLabel: type: string example: null dismissible: type: boolean example: false priority: type: number description: Tie-breaker within one severity only example: 90 dismissalKey: type: string description: Send to POST /platform/v1/user/dismissals to dismiss example: ann:8f14e45f-ceea-467a-9a1c-2b3f4d5e6a7b severity: type: string description: Clients render only the highest-severity notice example: critical enum: - info - warning - critical ```` ## Related topics - [Get account lockout status](/trade-api/account/get-account-lockout-status.md) - [Get lockout status for account](/platform-api/organization/get-lockout-status-for-account.md) - [Get copy trading status and positions](/trade-api/copy-trading/get-copy-trading-status-and-positions.md) - [List all active lockouts](/platform-api/organization/list-all-active-lockouts.md) - [Get active working orders](/trade-api/orders/get-active-working-orders.md)