> ## 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 consistency status; null when no consistency rule is configured or the status 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, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. 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: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/trading-accounts/{accountId}: get: tags: - Trading accounts 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 consistency status; null when no consistency rule is configured or the status 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/Model337' '401': description: Unauthorized - Invalid or missing API key content: '*/*': schema: $ref: '#/components/schemas/Model338' '403': description: Forbidden - This account belongs to a different organization content: '*/*': schema: $ref: '#/components/schemas/Model339' '404': description: Not Found - No account exists with this ID content: '*/*': schema: $ref: '#/components/schemas/Model340' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model337: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model336' Model338: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model339: 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 Model340: 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 Model5: 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 Model336: 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: ACME-100K-7845 type: $ref: '#/components/schemas/Model326' 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/Model327' 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/Model328' organization: $ref: '#/components/schemas/Model329' lockout: $ref: '#/components/schemas/Model330' tradingPlan: $ref: '#/components/schemas/Model331' tradingRule: $ref: '#/components/schemas/Model332' 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://cdn.example.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/Model333' purchase: $ref: '#/components/schemas/Model335' createdAt: type: string example: '2025-01-15T10:00:00.000Z' updatedAt: type: string example: '2025-01-20T14:30:00.000Z' Model326: type: string description: Account type example: evaluation enum: - evaluation - sim_funded - competition Model327: 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 Model328: type: object description: >- Live consistency calculation: cap, best day, profitable days, and blocking reasons Model329: type: object description: Owning organization properties: id: type: string name: type: string logoUrl: type: string Model330: 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 Model331: 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 Model332: 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' Model333: type: object description: Your customer info properties: email: type: string example: john.smith@email.com name: type: string example: John Smith Model335: 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/Model334' scalingPlan: type: object Model334: type: object securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Get a specific trading plan](/platform-api/trading-plans/get-a-specific-trading-plan.md) - [Get a specific trading rule](/platform-api/trading-rules/get-a-specific-trading-rule.md) - [Get trading accounts for your organization](/platform-api/trading-accounts/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) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.