Risk
Get per-plan unit economics and sustainability flags
Which of your trading plans make money and which are risks. One row per plan with sales, outcomes, attributable payouts, and a sustainability flag.
## Key fields
| Field | Description |
|-------|-------------|
| `unitsSold` / `revenueEstimated` | Paid purchases and their revenue (plan list price substituted when `price_paid` wasn't recorded, except for funded accounts) |
| `accounts` / `passRatePct` | Outcomes of accounts bought under the plan (SIM-BOT test accounts excluded) |
| `payoutsTotal` / `payoutRatioPct` | Executed payouts attributable to the plan |
| `netRevenue` / `netPerUnit` | Revenue minus payouts, total and per unit sold — the expected value of one more sale |
| `sustainability` | `red`: payout ratio ≥60% or pass rate ≥40% (rules too easy). `amber`: payout ratio ≥40% or pass rate <5% (traders churn and stop re-buying). `green` otherwise. `insufficient_data` under 20 completed accounts. |
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/plan-economics" \
-H "X-API-Key: hp_live_your_key_here"
```
**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
/
v1
/
organization
/
risk
/
plan-economics
Get per-plan unit economics and sustainability flags
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/risk/plan-economics \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/plan-economics"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/risk/plan-economics', 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/plan-economics",
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/plan-economics"
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))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/risk/plan-economics")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/plan-economics")
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": "<string>",
"plans": [
{
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "100K Pro",
"planPrice": 499,
"accountSize": 100000,
"planIsActive": true,
"unitsSold": 1306,
"revenueRecorded": 0,
"revenueEstimated": 651694,
"refundedCount": 12,
"refundedAmount": 5988,
"accounts": {
"total": 1300,
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5,
"notStarted": 0
},
"passRatePct": 5.45,
"payoutsTotal": 12400,
"payoutCount": 9,
"accountsWithPayouts": 4,
"payoutRatioPct": 1.9,
"netRevenue": 639294,
"netPerUnit": 489.5,
"avgDaysToOutcome": 6.2,
"sustainability": "green"
}
]
}
}{
"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
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.
⌘I
Get per-plan unit economics and sustainability flags
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/risk/plan-economics \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/plan-economics"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/risk/plan-economics', 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/plan-economics",
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/plan-economics"
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))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/risk/plan-economics")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/plan-economics")
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": "<string>",
"plans": [
{
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "100K Pro",
"planPrice": 499,
"accountSize": 100000,
"planIsActive": true,
"unitsSold": 1306,
"revenueRecorded": 0,
"revenueEstimated": 651694,
"refundedCount": 12,
"refundedAmount": 5988,
"accounts": {
"total": 1300,
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5,
"notStarted": 0
},
"passRatePct": 5.45,
"payoutsTotal": 12400,
"payoutCount": 9,
"accountsWithPayouts": 4,
"payoutRatioPct": 1.9,
"netRevenue": 639294,
"netPerUnit": 489.5,
"avgDaysToOutcome": 6.2,
"sustainability": "green"
}
]
}
}{
"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"
}