> ## 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 a specific trading account > Retrieve complete details for a single trading account by its ID. **When to use this:** - Display account details in your trader dashboard - Check account status and progress - View performance data and rule compliance - Get purchase and trader information **What you get:** - Account status, balances, total/daily P&L, drawdown inputs, and performance data - Complete trading plan and rule configuration (daily/max limits, drawdown type, consistency, scaling, max contracts) - Live consistency status (best day, daily cap, profitable days, blocking reasons) - Payout-cycle state, processed payout count, loss floor, markets, and active lockout - Organization identity (name/logo), trader, linked user, and purchase record - Trader info (your customer details) **Example:** ```http GET /organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7 ``` **Understanding the response:** - `trader` = Your customer info (from when you created the account) - `userId`/`userEmail` = Hyperprop platform user (when they claim the account) - `violationReason` = Why the account failed (e.g., "max_daily_loss") - `consistency` = Live engine calculation; null only when no consistency rule is configured or the engine is temporarily unavailable ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/trading-accounts/{accountId} 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/trading-accounts/{accountId}: get: tags: - Organization summary: Get a specific trading account description: >- Retrieve complete details for a single trading account by its ID. **When to use this:** - Display account details in your trader dashboard - Check account status and progress - View performance data and rule compliance - Get purchase and trader information **What you get:** - Account status, balances, total/daily P&L, drawdown inputs, and performance data - Complete trading plan and rule configuration (daily/max limits, drawdown type, consistency, scaling, max contracts) - Live consistency status (best day, daily cap, profitable days, blocking reasons) - Payout-cycle state, processed payout count, loss floor, markets, and active lockout - Organization identity (name/logo), trader, linked user, and purchase record - Trader info (your customer details) **Example:** ```http GET /organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7 ``` **Understanding the response:** - `trader` = Your customer info (from when you created the account) - `userId`/`userEmail` = Hyperprop platform user (when they claim the account) - `violationReason` = Why the account failed (e.g., "max_daily_loss") - `consistency` = Live engine calculation; null only when no consistency rule is configured or the engine is temporarily unavailable operationId: getV1OrganizationTradingaccountsAccountid parameters: - description: The account ID to retrieve x-format: guid: true name: accountId in: path required: true schema: type: string responses: '200': description: Success - Returns the trading account content: '*/*': schema: $ref: '#/components/schemas/Model307' '401': description: Unauthorized - Invalid or missing session token content: '*/*': schema: $ref: '#/components/schemas/Model308' '403': description: Forbidden - This account belongs to a different organization content: '*/*': schema: $ref: '#/components/schemas/Model309' '404': description: Not Found - No account exists with this ID content: '*/*': schema: $ref: '#/components/schemas/Model310' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model3' security: - Bearer: [] - X-API-Key: [] components: schemas: Model307: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model306' Model308: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model309: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: This account does not belong to your organization code: type: string example: ACCOUNT_NOT_IN_ORG Model310: type: object properties: statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Trading account not found code: type: string example: ACCOUNT_NOT_FOUND 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 Model306: type: object properties: id: type: string description: Unique account ID example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: type: string description: Human-readable account number example: APEX-100K-7845 type: $ref: '#/components/schemas/type' status: type: string description: Current status (not_started, in_progress, passed, failed, expired) example: in_progress initialBalance: type: number description: Starting balance example: 100000 currentBalance: type: number description: Current balance example: 105000 highWaterMark: type: number description: Highest balance achieved (for drawdown calculation) example: 108000 dailyStartingBalance: type: number description: Balance at start of current trading day example: 104000 totalPnl: type: number description: Realized total P&L (current balance - initial balance) example: 5000 dailyPnl: type: number description: Realized current-day P&L (current balance - daily starting balance) example: 1000 startedAt: type: string description: When trading started (null if not started) example: '2025-01-15T10:00:00.000Z' completedAt: type: string description: When account completed/failed (null if active) example: null violationReason: type: string description: Reason for failure (e.g., "max_daily_loss", "max_drawdown") example: null metadata: $ref: '#/components/schemas/Model297' performanceData: $ref: '#/components/schemas/performanceData' markets: $ref: '#/components/schemas/markets' cycleStartingBalance: type: number example: 100000 cycleStartedAt: type: string cycleProfit: type: number example: 5000 lossFloorBalance: type: number payoutCount: type: integer example: 0 completionPendingReason: type: string description: Plain-language reason a consistency gate is delaying pass/payout consistency: $ref: '#/components/schemas/Model298' organization: $ref: '#/components/schemas/Model299' lockout: $ref: '#/components/schemas/Model300' tradingPlan: $ref: '#/components/schemas/Model301' tradingRule: $ref: '#/components/schemas/Model302' userId: type: string description: Hyperprop user ID (null until the trader links the account) example: f994bc02-343c-4026-8a57-afc085eca8d5 userEmail: type: string description: Hyperprop user email (null until the trader links the account) example: mike.trader@gmail.com userAvatarUrl: type: string description: User profile avatar URL example: https://storage.hyperprop.com/avatars/user123.jpg importKey: type: string description: >- One-time redemption key — present only while the account is unlinked, null after import example: HP-7K3QF-9XT2M-4WHRD importedAt: type: string description: >- When the trader redeemed the import key (null if linked directly at creation or still unlinked) trader: $ref: '#/components/schemas/Model303' purchase: $ref: '#/components/schemas/Model305' createdAt: type: string example: '2025-01-15T10:00:00.000Z' updatedAt: type: string example: '2025-01-20T14:30:00.000Z' type: type: string description: Account type example: evaluation enum: - evaluation - sim_funded - competition Model297: type: object description: Custom metadata example: referredBy: john@partner.com prioritySupport: true performanceData: type: object description: Engine performance statistics stored for the account markets: type: array description: Markets/exchanges this account may trade example: - CME - CBOT - NYMEX - COMEX items: type: string Model298: type: object description: >- Live consistency calculation: cap, best day, profitable days, and blocking reasons Model299: type: object description: Owning organization properties: id: type: string name: type: string logoUrl: type: string Model300: type: object description: Currently active account lockout properties: active: type: boolean id: type: string mode: type: string reason: type: string lockedBy: type: string startsAt: type: string endsAt: type: string remainingMinutes: type: integer Model301: type: object description: The trading plan properties: id: type: string example: 550e8400-e29b-41d4-a716-446655440000 name: type: string example: 100K Challenge accountSize: type: number example: 100000 durationDays: type: number Model302: type: object description: Trading rules applied properties: id: type: string example: 660e8400-e29b-41d4-a716-446655440000 name: type: string example: Standard Rules description: type: string profitTarget: type: number example: 10000 dailyProfit: type: number maxProfit: type: number dailyLoss: type: number example: 2500 maxLoss: type: number example: 5000 dailyDrawdown: type: number example: 2.5 maxDrawdown: type: number example: 5 drawdownType: type: string example: static consistency: type: number example: 30 consistencyEnforced: type: boolean consistencyBase: type: string consistencyTolerancePct: type: number consistencyLeniency: type: number consistencyMinDays: type: integer consistencyProfitableDayMin: type: number maxPayouts: type: integer payoutMllLockOffset: type: number maxContracts: type: number description: >- Max position size in mini-equivalent contracts. A rule is not tied to a market, so this is always counted in ENGINE units: one unit is one futures contract, but 0.001 BTC on the Binance perpetual. A 0.1 BTC cap is therefore `100`, and 1 BTC is `1000`. Read `quantityStep` on the contract to convert. example: 5 microConversionRatio: type: number description: How many micros count as 1 unit toward maxContracts (default 10) example: 10 scalingPlan: $ref: '#/components/schemas/scalingPlan' Model303: type: object description: Your customer info properties: email: type: string example: john.smith@email.com name: type: string example: John Smith Model305: type: object description: Purchase record properties: id: type: string example: f47ac10b-58cc-4372-a567-0e02b2c3d479 purchaseDate: type: string example: '2025-01-10T10:00:00.000Z' pricePaid: type: number example: 499 currency: type: string example: USD metadata: $ref: '#/components/schemas/Model304' scalingPlan: type: object Model304: type: object 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 - [Get a specific trading plan](/platform-api/organization/get-a-specific-trading-plan.md) - [Get a specific trading rule](/platform-api/organization/get-a-specific-trading-rule.md) - [Get trading accounts for your organization](/platform-api/organization/get-trading-accounts-for-your-organization.md) - [Get all trading accounts for the authenticated user](/trade-api/account/get-all-trading-accounts-for-the-authenticated-user.md) - [Get current trading account with equity and P&L](/trade-api/account/get-current-trading-account-with-equity-and-p&l.md)