> ## 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:** send your organization API key in the `X-API-Key` header.



## 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, 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/risk/pnl:
    get:
      tags:
        - Analytics
      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:** send your organization API key in the `X-API-Key`
        header.
      operationId: getV1OrganizationRiskPnl
      responses:
        '200':
          description: Success — monthly firm P&L
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model292'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model287'
        '500':
          description: Internal error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model288'
      security:
        - X-API-Key: []
components:
  schemas:
    Model292:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model291'
    Model287:
      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
    Model288:
      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
    Model291:
      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/Model290'
        totals:
          $ref: '#/components/schemas/totals'
    Model290:
      type: array
      description: >-
        One row per calendar month with any revenue, payout, or billing
        activity, oldest first
      items:
        $ref: '#/components/schemas/Model289'
    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
    Model289:
      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:
    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 organization analytics](/platform-api/analytics/get-organization-analytics.md)
- [Get monthly billing summary](/platform-api/billing/get-monthly-billing-summary.md)
- [Get all-months billing aggregates](/platform-api/billing/get-all-months-billing-aggregates.md)
- [Get per-plan unit economics and sustainability flags](/platform-api/analytics/get-per-plan-unit-economics-and-sustainability-flags.md)
- [List API request logs](/platform-api/logs-and-health/list-api-request-logs.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.