> ## 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 payout forecast for the next 7 and 30 days

> How much you can expect to pay out in the next 7 and the next 30 days, with the figures it is built from.

## Method
The basis is the last 56 trading days. For each funded account we add up its profit on the days it closed in profit (`fundedProfit`), and compare that with the payouts executed over the same days (`conversionPct`). The forecast (`byProfit`) is that share of the funded accounts' average profitable-day profit, times the trading days ahead. `byRunRate` is the average payout per calendar day over the last 28 days, times the days ahead; `low` and `high` are the two methods' range. Exchange holidays are not taken out.

`openProfitOwed` is what active funded accounts hold above their starting balance now: profit that can still be requested.

Trading days follow the CME session (a day starts at 17:00 America/Chicago). Test accounts are excluded. Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old.

## Example

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/payout-forecast" \
  -H "X-API-Key: hp_live_your_key_here"
```

**Permissions:** requires **view** access to "Analytics".

**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/payout-forecast
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: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - 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/payout-forecast:
    get:
      tags:
        - Risk
      summary: Get a payout forecast for the next 7 and 30 days
      description: >-
        How much you can expect to pay out in the next 7 and the next 30 days,
        with the figures it is built from.


        ## Method

        The basis is the last 56 trading days. For each funded account we add up
        its profit on the days it closed in profit (`fundedProfit`), and compare
        that with the payouts executed over the same days (`conversionPct`). The
        forecast (`byProfit`) is that share of the funded accounts' average
        profitable-day profit, times the trading days ahead. `byRunRate` is the
        average payout per calendar day over the last 28 days, times the days
        ahead; `low` and `high` are the two methods' range. Exchange holidays
        are not taken out.


        `openProfitOwed` is what active funded accounts hold above their
        starting balance now: profit that can still be requested.


        Trading days follow the CME session (a day starts at 17:00
        America/Chicago). Test accounts are excluded. Results are recomputed at
        most every 15 minutes, so they can be up to 30 minutes old.


        ## Example


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/payout-forecast"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```


        **Permissions:** requires **view** access to "Analytics".


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Analytics & audit log.
      operationId: getV1OrganizationRiskPayoutforecast
      parameters:
        - name: If-None-Match
          in: header
          required: false
          description: >-
            Optional. The `ETag` of the answer you already have. When the answer
            would be the same, the response is `304` without a body.
          example: '"Hq3mB1c0s8n2JkVbQy4Tz9uXw5E"'
          schema:
            type: string
      responses:
        '200':
          description: Payout forecast
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model676'
        '304':
          description: >-
            Not modified: the answer is the same as the one whose `ETag` you
            sent in `If-None-Match`. No body; keep using the answer you have.
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model15'
        '403':
          description: This API key does not have admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model511'
        '429':
          description: >-
            Too many requests: this endpoint allows 60 calls per minute per
            organization. Wait the number of seconds in the `Retry-After`
            header. Also returned while your organization already has 6 reports
            being computed at once; wait the `Retry-After` seconds.
          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: Failed to build the payout forecast
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model677'
        '503':
          description: >-
            `FEATURE_NOT_READY`: the report is not available yet.
            `REPORT_TIMEOUT`: try again in a few minutes. The report took too
            long right now (`REPORT_TIMEOUT`). Wait the seconds in the
            `Retry-After` header (also `retryAfterSeconds` in the body) before
            asking again; the wait grows while the report keeps running out of
            time.
        '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/Model678'
      security:
        - X-API-Key: []
components:
  schemas:
    Model676:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model675'
    Model15:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model511:
      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: This API key does not have admin permissions
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INSUFFICIENT_PERMISSIONS
    Model677:
      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: Failed to build the payout forecast
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: FORECAST_ERROR
    Model678:
      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
    Model675:
      type: object
      properties:
        organizationId:
          type: string
          example: 55555555-5555-4555-8555-555555555555
          x-format:
            guid: true
        generatedAt:
          type: string
          example: '2026-11-14T08:00:00.000Z'
          x-format:
            isoDate: true
        currency:
          type: string
          example: USD
        asOfTradingDay:
          type: string
          description: >-
            Trading day in progress (a day starts at 17:00 America/Chicago and
            is named by the date it ends on)
          example: '2026-11-14'
        confidence:
          $ref: '#/components/schemas/confidence'
        horizons:
          $ref: '#/components/schemas/horizons'
        openProfitOwed:
          type: number
          description: >-
            Profit above the starting balance on funded accounts that are still
            active, now
          example: 2104596.12
        fundedInProgress:
          type: integer
          description: Funded accounts that are still active
          example: 1728
        basis:
          $ref: '#/components/schemas/basis'
        weeks:
          $ref: '#/components/schemas/weeks'
    confidence:
      type: string
      description: >-
        `insufficient_data`: fewer than 5 payouts or 10 trading days in the
        basis. `partial`: daily trading totals start after the basis does.
      example: ok
      enum:
        - ok
        - partial
        - insufficient_data
    horizons:
      type: array
      description: The next 7 and the next 30 days
      items:
        $ref: '#/components/schemas/Model673'
    basis:
      type: object
      description: The last 56 trading-day dates before today
      properties:
        from:
          type: string
          example: '2026-09-19'
        to:
          type: string
          example: '2026-11-13'
        tradingDays:
          type: integer
          description: Trading days in the basis with closed trades
          example: 40
        fundedProfit:
          type: number
          description: >-
            Sum of each funded account's profit on the trading days it closed in
            profit
          example: 26712613
        fundedNetProfit:
          type: number
          description: Funded accounts' net profit and loss over the basis
          example: -7320707
        payouts:
          type: number
          example: 16548955
        payoutCount:
          type: integer
          example: 22550
        conversionPct:
          type: number
          description: payouts ÷ fundedProfit × 100, at most 100
          example: 61.95
        profitPerTradingDay:
          type: number
          description: fundedProfit ÷ tradingDays
          example: 667815.33
        payoutsLast28Days:
          type: number
          example: 8272480
        payoutCountLast28Days:
          type: integer
          example: 11402
    weeks:
      type: array
      description: The basis in blocks of 7 days, newest first
      items:
        $ref: '#/components/schemas/Model674'
    Model673:
      type: object
      properties:
        days:
          type: integer
          description: Calendar days, today included
          example: 7
          enum:
            - 7
            - 30
        tradingDays:
          type: integer
          description: >-
            Trading days in those calendar days (Monday to Friday; exchange
            holidays are not taken out)
          example: 5
        until:
          type: string
          description: Last calendar date of the horizon
          example: '2026-11-20'
        expected:
          type: number
          description: >-
            Forecast payouts: `byProfit` when the basis has funded profit, else
            `byRunRate`
          example: 2310400.5
        low:
          type: number
          description: The lower of `expected` and `byRunRate`
          example: 2310400.5
        high:
          type: number
          description: The higher of `expected` and `byRunRate`
          example: 2955170
        byProfit:
          type: number
          description: >-
            conversionPct × profitPerTradingDay × tradingDays: what the funded
            accounts are expected to earn on their profitable days, times the
            share of such profit that was paid out in the basis. Null without
            funded profit in the basis.
          example: 2310400.5
        byRunRate:
          type: number
          description: >-
            Average payouts per calendar day over the last 28 days, times the
            days of the horizon
          example: 2955170
    Model674:
      type: object
      properties:
        from:
          type: string
          example: '2026-11-07'
        to:
          type: string
          example: '2026-11-13'
        payouts:
          type: number
          example: 2120000
        payoutCount:
          type: integer
          example: 2900
        fundedProfit:
          type: number
          example: 3400000
        fundedNetProfit:
          type: number
          example: -900000
  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 trader behavior by plan](https://docs.hyperprop.com/platform-api/risk/get-trader-behavior-by-plan.md)
- [Set the summary email](https://docs.hyperprop.com/platform-api/risk/set-the-summary-email.md)
- [Get hourly activity by weekday](https://docs.hyperprop.com/platform-api/analytics/get-hourly-activity-by-weekday.md)
- [Get daily payout activity](https://docs.hyperprop.com/platform-api/payouts/get-daily-payout-activity.md)
- [Get fills for a trading day](https://docs.hyperprop.com/platform-api/reconciliation/get-fills-for-a-trading-day.md)


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