> ## 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 rule > Retrieve complete details for a single trading rule by its ID. **When to use this:** - Display rule details on your website - Verify rule configuration before creating an account - Show rule breakdown in your admin dashboard **What you get:** - All rule parameters (profit target, loss limits, drawdown limits) - Position size limits (max contracts) - Consistency requirements - Custom metadata you've stored **Example:** ```http GET /organization/trading-rules/660e8400-e29b-41d4-a716-446655440000 ``` ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/trading-rules/{ruleId} 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-rules/{ruleId}: get: tags: - Trading rules summary: Get a specific trading rule description: |- Retrieve complete details for a single trading rule by its ID. **When to use this:** - Display rule details on your website - Verify rule configuration before creating an account - Show rule breakdown in your admin dashboard **What you get:** - All rule parameters (profit target, loss limits, drawdown limits) - Position size limits (max contracts) - Consistency requirements - Custom metadata you've stored **Example:** ```http GET /organization/trading-rules/660e8400-e29b-41d4-a716-446655440000 ``` operationId: getV1OrganizationTradingrulesRuleid parameters: - description: The rule ID to retrieve x-format: guid: true name: ruleId in: path required: true schema: type: string responses: '200': description: Success - Returns the trading rule content: '*/*': schema: $ref: '#/components/schemas/Model352' '401': description: Unauthorized - Invalid or missing API key content: '*/*': schema: $ref: '#/components/schemas/Model353' '403': description: Forbidden - This rule belongs to a different organization content: '*/*': schema: $ref: '#/components/schemas/Model354' '404': description: Not Found - No rule exists with this ID content: '*/*': schema: $ref: '#/components/schemas/Model355' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model352: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model351' Model353: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model354: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: This rule does not belong to your organization code: type: string example: RULE_NOT_IN_ORG Model355: type: object properties: statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Trading rule not found code: type: string example: RULE_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 Model351: type: object properties: id: type: string description: Unique rule ID example: 660e8400-e29b-41d4-a716-446655440000 name: type: string description: Rule set display name example: Standard Challenge Rules description: type: string description: Rule set description example: Balanced rules for most traders. 10% profit target, 5% max drawdown. profitTarget: type: number description: Profit target to pass ($) example: 10000 dailyProfit: type: number description: Max daily profit cap (0 = unlimited) example: 0 maxProfit: type: number description: Max total profit cap (0 = unlimited) example: 0 dailyLoss: type: number description: Max loss allowed per day ($) example: 2500 maxLoss: type: number description: Max total loss from starting balance ($) example: 5000 dailyDrawdown: type: number description: Max drawdown from day's starting balance ($) example: 2500 maxDrawdown: type: number description: Max drawdown from high water mark ($) example: 5000 drawdownType: $ref: '#/components/schemas/drawdownType' drawdownDenomination: $ref: '#/components/schemas/drawdownDenomination' drawdownTrailCeiling: type: number description: >- Trailing floor lock level, dollars above initial balance (null = trails forever) example: null newsTradingAllowed: type: boolean description: 'Display-only: trading during news allowed' example: true microscalpingAllowed: type: boolean description: 'Display-only: microscalping allowed' example: true weekendHoldingAllowed: type: boolean description: 'Display-only: weekend holding allowed' example: true overnightHoldingAllowed: type: boolean description: 'Display-only: overnight holding allowed' example: true consistency: type: number description: Consistency rule % (0 = disabled) example: 50 consistencyEnforced: type: boolean description: >- Whether the engine enforces the consistency rule for accounts on this rule set consistencyBase: type: string description: Configured base mode (null = automatic by account type) consistencyTolerancePct: type: number description: Daily-cap buffer as % of starting balance consistencyLeniency: type: number description: Flat $ daily-cap buffer consistencyMinDays: type: number description: Min profitable days (null = auto ceil(100/consistency)) consistencyProfitableDayMin: type: number description: Min net PnL ($) for a day to count as profitable maxPayouts: type: number description: >- Payout count that triggers account.max_payouts_reached (null = unlimited) payoutMllLockOffset: type: number description: Default move_mll_to_lock offset ($ above initial balance) 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: 10 microConversionRatio: type: number description: >- How many micros count as 1 unit toward maxContracts (default 10; 5 = 5 micros per mini, 1 = micros count fully) example: 10 personalRiskPolicy: $ref: '#/components/schemas/Model348' scalingPlan: $ref: '#/components/schemas/Model349' metadata: $ref: '#/components/schemas/Model350' createdAt: type: string example: '2025-01-15T10:00:00.000Z' updatedAt: type: string example: '2025-01-20T14:30:00.000Z' drawdownType: type: string description: >- How drawdown is calculated: static (from initial balance), trailing (real-time from HWM), eod (trailing, updates at market close) example: trailing enum: - static - trailing - eod drawdownDenomination: type: string description: >- Unit of maxDrawdown: percent of the reference (default) or a fixed dollar amount below it example: percent enum: - percent - dollars Model348: type: object description: >- Firm bounds on trader-set personal risk controls (null = traders unconstrained) example: dailyLossLimitMax: 1000 dailyLossLimitDefault: 500 requireDailyLossLimit: true maxTradesPerDayMax: 20 Model349: type: object description: Profit-based contract scaling tiers (null = flat maxContracts applies) example: basis: balance tiers: - profit: 0 maxContracts: 1 - profit: 1000 maxContracts: 2 - profit: 3000 maxContracts: 5.5 Model350: type: object description: Custom metadata example: ruleVersion: '2.1' market: futures weekendHoldingAllowed: false 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 account](/platform-api/trading-accounts/get-a-specific-trading-account.md) - [Get trading rules for your organization](/platform-api/trading-rules/get-trading-rules-for-your-organization.md) - [Get a specific purchase](/platform-api/purchases/get-a-specific-purchase.md) - [Get a specific trader](/platform-api/traders/get-a-specific-trader.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.