> ## 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 monthly firm P&L (revenue vs payouts vs platform costs) > Monthly profitability of your firm on Hyperprop: evaluation revenue in, trader payouts and your Hyperprop platform/CME bill out. ## What you get One row per calendar month (America/Chicago, matching your billing months) with: | Field | Description | |-------|-------------| | `revenueEstimated` | Purchase revenue. If your integration sends `price_paid` on purchases we use it; otherwise we substitute the plan's list price and flag the basis in `revenueBasis`. | | `payouts` | Executed trader withdrawals in that month | | `platformCosts` | Your Hyperprop bill (platform fee + CME market data per billed trader) | | `net` / `marginPct` | revenue − payouts − platform costs, and margin | `totals` sums all months and includes the all-time `payoutRatioPct` (payouts ÷ revenue) — the number prop firms watch most. ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/risk/pnl" \ -H "X-API-Key: hp_live_your_key_here" ``` **Tip:** send the real `pricePaid` when creating purchases and your revenue becomes exact instead of estimated. **Authentication:** Accepts either `Authorization: Bearer ` (dashboard) or `X-API-Key: hp_live_...` (programmatic). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/risk/pnl 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/risk/pnl: get: tags: - Organization summary: Get monthly firm P&L (revenue vs payouts vs platform costs) description: >- Monthly profitability of your firm on Hyperprop: evaluation revenue in, trader payouts and your Hyperprop platform/CME bill out. ## What you get One row per calendar month (America/Chicago, matching your billing months) with: | Field | Description | |-------|-------------| | `revenueEstimated` | Purchase revenue. If your integration sends `price_paid` on purchases we use it; otherwise we substitute the plan's list price and flag the basis in `revenueBasis`. | | `payouts` | Executed trader withdrawals in that month | | `platformCosts` | Your Hyperprop bill (platform fee + CME market data per billed trader) | | `net` / `marginPct` | revenue − payouts − platform costs, and margin | `totals` sums all months and includes the all-time `payoutRatioPct` (payouts ÷ revenue) — the number prop firms watch most. ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/risk/pnl" \ -H "X-API-Key: hp_live_your_key_here" ``` **Tip:** send the real `pricePaid` when creating purchases and your revenue becomes exact instead of estimated. **Authentication:** Accepts either `Authorization: Bearer ` (dashboard) or `X-API-Key: hp_live_...` (programmatic). operationId: getV1OrganizationRiskPnl responses: '200': description: Success — monthly firm P&L content: '*/*': schema: $ref: '#/components/schemas/Model271' '401': description: Unauthorized content: '*/*': schema: $ref: '#/components/schemas/Model266' '500': description: Internal error content: '*/*': schema: $ref: '#/components/schemas/Model267' security: - Bearer: [] - X-API-Key: [] components: schemas: Model271: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model270' Model266: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired token code: type: string example: UNAUTHORIZED Model267: type: object properties: statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: Failed to fetch firm P&L code: type: string example: RISK_ERROR Model270: type: object properties: organizationId: type: string example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 x-format: guid: true currency: type: string example: USD revenueBasis: type: string description: How revenue figures were derived example: >- Purchase price when the firm recorded one; plan list price otherwise (estimated). Months follow America/Chicago. months: $ref: '#/components/schemas/Model269' totals: $ref: '#/components/schemas/totals' Model269: type: array description: >- One row per calendar month with any revenue, payout, or billing activity, oldest first items: $ref: '#/components/schemas/Model268' totals: type: object properties: revenueEstimated: type: number example: 889672 payouts: type: number example: 48200 platformCosts: type: number example: 16660 net: type: number example: 824812 payoutRatioPct: type: number description: All-time payouts / revenue × 100 — the core prop-firm health metric example: 5.4 Model268: type: object properties: month: type: string description: Calendar month (YYYY-MM, America/Chicago — same clock as billing) example: 2026-07 revenueRecorded: type: number description: >- Sum of price_paid your integration sent on purchases. Most firms send 0 — see revenueBasis. example: 0 revenueEstimated: type: number description: >- Revenue with plan list price substituted where price_paid was 0. Use this unless you record real prices. example: 809697 purchaseCount: type: integer description: Paid purchases in the month example: 2353 payouts: type: number description: Executed trader payouts (withdrawals) in the month example: 48200 payoutCount: type: integer example: 31 platformCosts: type: number description: >- Your Hyperprop bill for the month: platform fee + CME market data per billed trader example: 13753 billedTraders: type: integer description: Distinct traders you were billed for in the month example: 809 net: type: number description: revenueEstimated − payouts − platformCosts example: 747744 marginPct: type: number description: net / revenueEstimated × 100. Null when the month has no revenue. example: 92.3 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 organization analytics](/platform-api/organization/get-organization-analytics.md) - [Get monthly billing summary](/platform-api/organization/get-monthly-billing-summary.md) - [Get all-months billing aggregates](/platform-api/organization/get-all-months-billing-aggregates.md) - [Get per-plan unit economics and sustainability flags](/platform-api/organization/get-per-plan-unit-economics-and-sustainability-flags.md) - [Get trade execution history](/trade-api/orders/get-trade-execution-history.md)