Read the risk money summary
What the risk reports are worth in money, for the traders flagged in the last days trading days. Amounts are in the account currency, before your profit split, and may be up to a minute old.
atStake: traders not yet reviewed, and the profit above the starting balance on their funded accounts that are not failed, passed or expired. Payouts are taken off the balance, so this is the most those accounts could still ask to be paid.byLevelsplits it by the trader’s highest level.watching: the same for traders whose latest decision iswatching.paidBeforeReview: payouts (not reversed) made to flagged traders after their flag was first shown and before anyone recorded a review or decision on them.toConfirmedis the part paid to traders whose latest decision isconfirmed.protected: for each trader whose latest decision isconfirmed, the profit their open funded accounts held when the decision was recorded, less what was paid out on those accounts since.thisMonthcounts decisions from the first of the month (UTC),allTimeevery one.hedgeProfit: in the flagging hedge findings of the period (between two traders, or one trader’s own accounts), the winning side’s profit when it is on a funded account.
curl "https://api.hyperprop.com/platform/v1/organization/risk/value?days=7" \
-H "X-API-Key: hp_live_your_key_here"
Permissions: requires view access to “Traders & accounts”.
Access: read-only and full-access API keys. Dashboard members need view access to Traders & accounts.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/risk/value \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/value"
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/value', 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/value",
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/value"
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/value")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/value")
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": "<string>",
"from": "2026-11-08",
"to": "2026-11-14",
"minLevel": "medium",
"flaggedTraders": 405,
"reviewStateAvailable": true,
"coverage": {
"from": "2026-11-06",
"to": "2026-11-12",
"complete": false,
"days": [
{
"tradingDay": "2026-11-11",
"state": "failed",
"expectedAt": "2026-11-16T23:10:00.000Z",
"reports": {},
"truncated": [
"<string>"
]
}
],
"failedDays": 1,
"pendingDays": 0,
"truncatedDays": 0,
"missingDays": 0
},
"atStake": {
"amount": 111907.12,
"traders": 95,
"accounts": 108,
"byLevel": {
"medium": {
"amount": 111907.12,
"traders": 95,
"accounts": 108
},
"high": {
"amount": 111907.12,
"traders": 95,
"accounts": 108
}
}
},
"watching": {
"amount": 111907.12,
"traders": 95,
"accounts": 108
},
"paidBeforeReview": {
"amount": 2354,
"payouts": 2,
"traders": 2,
"toConfirmed": {
"amount": 2354,
"payouts": 2,
"traders": 2
}
},
"protected": {
"thisMonth": {
"amount": 0,
"traders": 0,
"unmeasured": 0,
"from": "2026-11-01T00:00:00.000Z"
},
"allTime": {
"amount": 0,
"traders": 0,
"unmeasured": 0,
"since": "<string>"
}
},
"hedgeProfit": {
"amount": 9984.2,
"hedges": 337,
"findings": 241
},
"computedAt": "<string>"
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid request data",
"code": "BAD_REQUEST"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "This API key does not have admin permissions",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"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": 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.
Headers
Query Parameters
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/risk/value \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/value"
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/value', 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/value",
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/value"
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/value")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/value")
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": "<string>",
"from": "2026-11-08",
"to": "2026-11-14",
"minLevel": "medium",
"flaggedTraders": 405,
"reviewStateAvailable": true,
"coverage": {
"from": "2026-11-06",
"to": "2026-11-12",
"complete": false,
"days": [
{
"tradingDay": "2026-11-11",
"state": "failed",
"expectedAt": "2026-11-16T23:10:00.000Z",
"reports": {},
"truncated": [
"<string>"
]
}
],
"failedDays": 1,
"pendingDays": 0,
"truncatedDays": 0,
"missingDays": 0
},
"atStake": {
"amount": 111907.12,
"traders": 95,
"accounts": 108,
"byLevel": {
"medium": {
"amount": 111907.12,
"traders": 95,
"accounts": 108
},
"high": {
"amount": 111907.12,
"traders": 95,
"accounts": 108
}
}
},
"watching": {
"amount": 111907.12,
"traders": 95,
"accounts": 108
},
"paidBeforeReview": {
"amount": 2354,
"payouts": 2,
"traders": 2,
"toConfirmed": {
"amount": 2354,
"payouts": 2,
"traders": 2
}
},
"protected": {
"thisMonth": {
"amount": 0,
"traders": 0,
"unmeasured": 0,
"from": "2026-11-01T00:00:00.000Z"
},
"allTime": {
"amount": 0,
"traders": 0,
"unmeasured": 0,
"since": "<string>"
}
},
"hedgeProfit": {
"amount": 9984.2,
"hedges": 337,
"findings": 241
},
"computedAt": "<string>"
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Invalid request data",
"code": "BAD_REQUEST"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "This API key does not have admin permissions",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"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": 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"
}