Risk

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

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.

GET

organization

risk

pnl

Get monthly firm P&L (revenue vs payouts vs platform costs)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/risk/pnl \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/risk/pnl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/risk/pnl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/risk/pnl"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/risk/pnl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "55555555-5555-4555-8555-555555555555",
    "currency": "USD",
    "revenueBasis": "Purchase price when the firm recorded one; plan list price otherwise (estimated), except for funded accounts. Months follow America/Chicago.",
    "months": [
      {
        "month": "2026-07",
        "revenueRecorded": 0,
        "revenueEstimated": 809697,
        "purchaseCount": 2353,
        "payouts": 48200,
        "payoutCount": 31,
        "platformCosts": 13753,
        "billedTraders": 809,
        "net": 747744,
        "marginPct": 92.3
      }
    ],
    "totals": {
      "revenueEstimated": 889672,
      "payouts": 48200,
      "platformCosts": 16660,
      "net": 824812,
      "payoutRatioPct": 5.4
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to this endpoint. Try again in 12 second(s).",
  "code": "RATE_LIMITED"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "Failed to fetch firm P&L",
  "code": "RISK_ERROR"
}

{
  "statusCode": 504,
  "error": "Gateway Timeout",
  "message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
  "code": "REQUEST_TIMEOUT"
}

Authorizations

X-API-Key

string

header

required

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.

Response

Success — monthly firm P&L

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Get monthly firm P&L (revenue vs payouts vs platform costs)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/risk/pnl \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/risk/pnl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/risk/pnl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/risk/pnl"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/risk/pnl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "55555555-5555-4555-8555-555555555555",
    "currency": "USD",
    "revenueBasis": "Purchase price when the firm recorded one; plan list price otherwise (estimated), except for funded accounts. Months follow America/Chicago.",
    "months": [
      {
        "month": "2026-07",
        "revenueRecorded": 0,
        "revenueEstimated": 809697,
        "purchaseCount": 2353,
        "payouts": 48200,
        "payoutCount": 31,
        "platformCosts": 13753,
        "billedTraders": 809,
        "net": 747744,
        "marginPct": 92.3
      }
    ],
    "totals": {
      "revenueEstimated": 889672,
      "payouts": 48200,
      "platformCosts": 16660,
      "net": 824812,
      "payoutRatioPct": 5.4
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to this endpoint. Try again in 12 second(s).",
  "code": "RATE_LIMITED"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "Failed to fetch firm P&L",
  "code": "RISK_ERROR"
}

{
  "statusCode": 504,
  "error": "Gateway Timeout",
  "message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
  "code": "REQUEST_TIMEOUT"
}

Platform API

Trade API

Get monthly firm P&L (revenue vs payouts vs platform costs)

What you get

Example

Authorizations

Response