List flagged traders
Every trader flagged by the daily risk reports in the last days trading days, with what flagged them and your review state, most recently flagged first. A trader is flagged by a hedge pair, a copy group, a copy pair seen on two or more days, a shared device or an address with overlapping sessions or trading, or an order that opened a position inside a news window. Set the review state with PUT /risk/inbox/{traderId}; a trader flagged again on a later trading day shows as new again.
summary counts all flagged traders by state. reviewStateAvailable is false while review states cannot be saved yet; every trader is then new.
Each trader’s stake says what is at stake in money: the profit their funded accounts could still pay out, how many funded accounts they hold, and what was paid out to them after the flag was shown and before a review. Amounts are in the account currency, before your profit split. When it cannot be read in time, stake is null and stakeAvailable false; the list is still complete. It may be up to a minute old.
curl "https://api.hyperprop.com/platform/v1/organization/risk/inbox?days=7&state=new&sort=stake" \
-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/inbox \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/inbox"
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/inbox', 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/inbox",
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/inbox"
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/inbox")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/inbox")
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-06",
"to": "2026-11-12",
"reviewStateAvailable": true,
"summary": {
"new": 4,
"reviewed": 2,
"cleared": 9
},
"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
},
"stakeAvailable": true,
"traders": [
{
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"userId": "<string>",
"traderName": "<string>",
"traderEmail": "<string>",
"accounts": [
{
"accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-50K-000123",
"customerId": "cust-4471",
"accountType": "sim_funded",
"status": "in_progress",
"planId": "<string>",
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"userId": "<string>",
"traderName": "Jane Trader",
"traderEmail": "jane@example.com"
}
],
"counts": {
"hedge_pairs": 2,
"copy_pairs": 0,
"copy_groups": 1,
"shared_devices": 1,
"news_window_fills": 0,
"self_hedges": 1
},
"totalFlags": 4,
"firstDay": "2026-11-10",
"lastDay": "2026-11-12",
"items": [
{
"report": "hedge_pairs",
"tradingDay": "2026-11-12",
"rowId": "<string>",
"summary": "Opposite NQ positions with another trader for 412 s",
"level": "medium"
}
],
"level": "high",
"levels": {
"low": 123,
"medium": 123,
"high": 123
},
"review": {
"state": "new",
"savedState": "cleared",
"outcome": "confirmed",
"reason": "same_household",
"note": "<string>",
"updatedAt": "<string>"
},
"stake": {
"payableProfit": 12400.5,
"fundedAccounts": 2,
"paidBeforeReview": 850,
"payoutPending": "<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/inbox \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/inbox"
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/inbox', 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/inbox",
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/inbox"
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/inbox")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/inbox")
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-06",
"to": "2026-11-12",
"reviewStateAvailable": true,
"summary": {
"new": 4,
"reviewed": 2,
"cleared": 9
},
"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
},
"stakeAvailable": true,
"traders": [
{
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"userId": "<string>",
"traderName": "<string>",
"traderEmail": "<string>",
"accounts": [
{
"accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-50K-000123",
"customerId": "cust-4471",
"accountType": "sim_funded",
"status": "in_progress",
"planId": "<string>",
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"userId": "<string>",
"traderName": "Jane Trader",
"traderEmail": "jane@example.com"
}
],
"counts": {
"hedge_pairs": 2,
"copy_pairs": 0,
"copy_groups": 1,
"shared_devices": 1,
"news_window_fills": 0,
"self_hedges": 1
},
"totalFlags": 4,
"firstDay": "2026-11-10",
"lastDay": "2026-11-12",
"items": [
{
"report": "hedge_pairs",
"tradingDay": "2026-11-12",
"rowId": "<string>",
"summary": "Opposite NQ positions with another trader for 412 s",
"level": "medium"
}
],
"level": "high",
"levels": {
"low": 123,
"medium": 123,
"high": 123
},
"review": {
"state": "new",
"savedState": "cleared",
"outcome": "confirmed",
"reason": "same_household",
"note": "<string>",
"updatedAt": "<string>"
},
"stake": {
"payableProfit": 12400.5,
"fundedAccounts": 2,
"paidBeforeReview": 850,
"payoutPending": "<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"
}