> ## 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`. Funded accounts count only a price you sent, never the list price. | | `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. Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old. ## 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. **Permissions:** requires **view** access to "Analytics". **Authentication:** send your organization API key in the `X-API-Key` header. **Access:** read-only and full-access API keys. Dashboard members need view access to Analytics & audit log. ## OpenAPI ````yaml https://api.hyperprop.com/platform/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, 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: Instruments description: >- The contracts your organization's accounts can trade, with their specifications. - 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: Mass credit description: >- Credit back losses across many accounts after an incident, as background jobs you can follow, pause, export and reverse. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history, to replay or audit what happened. - name: Real-time streams description: >- Live events and trading data over a WebSocket, for dashboards and CRMs that update as things happen. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance, revenue and top traders. - name: Risk description: Firm profit and loss and plan economics. - name: Billing and invoices description: >- Your Hyperprop invoices, credits and billing details, with usage so far this month, billing cycles, forecasts and CSV exports. - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: >- Manage your organization's API keys: rotation, read-only keys and IP allowlists. - name: Logs and health description: >- API request logs, the audit log, integration health, and idempotency key recovery. - 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/risk/pnl: get: tags: - Risk 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`. Funded accounts count only a price you sent, never the list price. | | `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. Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old. ## 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. **Permissions:** requires **view** access to "Analytics". **Authentication:** send your organization API key in the `X-API-Key` header. **Access:** read-only and full-access API keys. Dashboard members need view access to Analytics & audit log. operationId: getV1OrganizationRiskPnl responses: '200': description: Success — monthly firm P&L content: application/json: schema: $ref: '#/components/schemas/Model525' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Model519' '403': description: Access denied content: application/json: schema: $ref: '#/components/schemas/Model74' '429': description: >- Too many requests: this endpoint allows 60 calls per minute per organization. Wait the number of seconds in the `Retry-After` header. content: application/json: schema: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: integer example: 429 error: type: string example: Too Many Requests message: type: string example: >- Too many requests to this endpoint. Try again in 12 second(s). code: type: string enum: - RATE_LIMITED example: RATE_LIMITED description: >- Machine-readable error code — switch on this, not on message text '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/Model520' '504': description: >- Gateway Timeout - The request did not complete within 25 seconds (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the request (for example a shorter date range). content: application/json: schema: $ref: '#/components/schemas/Model526' security: - X-API-Key: [] components: schemas: Model525: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model524' Model519: 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 Model74: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model520: 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 Model526: type: object properties: statusCode: type: number example: 504 error: type: string example: Gateway Timeout message: type: string example: >- The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range). code: type: string description: Machine-readable error code — switch on this, not on message text example: REQUEST_TIMEOUT Model524: type: object properties: organizationId: type: string example: 55555555-5555-4555-8555-555555555555 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), except for funded accounts. Months follow America/Chicago. months: $ref: '#/components/schemas/Model523' totals: $ref: '#/components/schemas/totals' Model523: type: array description: >- One row per calendar month with any revenue, payout, or billing activity, oldest first items: $ref: '#/components/schemas/Model522' 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 Model522: 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 (never for funded accounts). 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: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**. ```` ## Related topics - [Get monthly billing summary](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-monthly-billing-summary.md) - [Get all-months billing aggregates](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-all-months-billing-aggregates.md) - [Get organization analytics](https://docs.hyperprop.com/platform-api/analytics/get-organization-analytics.md) - [Get revenue breakdown](https://docs.hyperprop.com/platform-api/analytics/get-revenue-breakdown.md) - [Get per-plan unit economics and sustainability flags](https://docs.hyperprop.com/platform-api/risk/get-per-plan-unit-economics-and-sustainability-flags.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.