Set your alert limits
Replaces your alert limits (an empty list removes all). Every 5 minutes Hyperprop compares each figure with its limit. When a figure reaches its limit you get one alert.limit_crossed event, and alert.limit_cleared once it is more than 5% below it again. Events go to your webhooks that list these types (explicit subscription only), to the portal’s notifications, and to GET /risk/alerts.
Changing a limit judges it afresh: a figure that is already above the new limit alerts again at the next check.
| Figure | What it measures | Unit |
|---|---|---|
open_profit_owed | Profit above the starting balance on active funded accounts | USD |
accounts_near_breach | Active accounts with 10% or less of their loss limit left | count |
exposure_limits_breached | Markets whose live net size is above the exposure limit set for them | count |
Example
curl -X PUT "https://api.hyperprop.com/platform/v1/organization/risk/alert-limits" \
-H "X-API-Key: hp_live_your_key_here" -H "Content-Type: application/json" \
-d '{"limits":[{"metric":"open_profit_owed","threshold":250000},{"metric":"accounts_near_breach","threshold":50}]}'
Permissions: requires manage access to “Analytics”.
Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Analytics & audit log.
curl --request PUT \
--url https://api.hyperprop.com/platform/v1/organization/risk/alert-limits \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"limits": [
{
"metric": "open_profit_owed",
"threshold": 250000,
"enabled": true
}
]
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/alert-limits"
payload = { "limits": [
{
"metric": "open_profit_owed",
"threshold": 250000,
"enabled": True
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({limits: [{metric: 'open_profit_owed', threshold: 250000, enabled: true}]})
};
fetch('https://api.hyperprop.com/platform/v1/organization/risk/alert-limits', 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/alert-limits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'limits' => [
[
'metric' => 'open_profit_owed',
'threshold' => 250000,
'enabled' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/risk/alert-limits"
payload := strings.NewReader("{\n \"limits\": [\n {\n \"metric\": \"open_profit_owed\",\n \"threshold\": 250000,\n \"enabled\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.hyperprop.com/platform/v1/organization/risk/alert-limits")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limits\": [\n {\n \"metric\": \"open_profit_owed\",\n \"threshold\": 250000,\n \"enabled\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/alert-limits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limits\": [\n {\n \"metric\": \"open_profit_owed\",\n \"threshold\": 250000,\n \"enabled\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "55555555-5555-4555-8555-555555555555",
"limits": [
{
"metric": "open_profit_owed",
"label": "Open profit owed",
"unit": "usd",
"description": "Profit above the starting balance on active funded accounts",
"threshold": 250000,
"enabled": true,
"crossed": false,
"lastAlert": {
"state": "crossed",
"value": 262410,
"at": "<string>"
},
"updatedAt": "<string>",
"updatedBy": "Jane Doe"
}
],
"metrics": [
{
"metric": "open_profit_owed",
"label": "Open profit owed",
"unit": "usd",
"description": "Profit above the starting balance on active funded accounts"
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Each figure can have one limit",
"code": "DUPLICATE_METRIC"
}{
"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": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "Failed to save the alert limits",
"code": "ALERT_LIMITS_ERROR"
}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
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
255Body
curl --request PUT \
--url https://api.hyperprop.com/platform/v1/organization/risk/alert-limits \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"limits": [
{
"metric": "open_profit_owed",
"threshold": 250000,
"enabled": true
}
]
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/alert-limits"
payload = { "limits": [
{
"metric": "open_profit_owed",
"threshold": 250000,
"enabled": True
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({limits: [{metric: 'open_profit_owed', threshold: 250000, enabled: true}]})
};
fetch('https://api.hyperprop.com/platform/v1/organization/risk/alert-limits', 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/alert-limits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'limits' => [
[
'metric' => 'open_profit_owed',
'threshold' => 250000,
'enabled' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/risk/alert-limits"
payload := strings.NewReader("{\n \"limits\": [\n {\n \"metric\": \"open_profit_owed\",\n \"threshold\": 250000,\n \"enabled\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.hyperprop.com/platform/v1/organization/risk/alert-limits")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limits\": [\n {\n \"metric\": \"open_profit_owed\",\n \"threshold\": 250000,\n \"enabled\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/alert-limits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limits\": [\n {\n \"metric\": \"open_profit_owed\",\n \"threshold\": 250000,\n \"enabled\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "55555555-5555-4555-8555-555555555555",
"limits": [
{
"metric": "open_profit_owed",
"label": "Open profit owed",
"unit": "usd",
"description": "Profit above the starting balance on active funded accounts",
"threshold": 250000,
"enabled": true,
"crossed": false,
"lastAlert": {
"state": "crossed",
"value": 262410,
"at": "<string>"
},
"updatedAt": "<string>",
"updatedBy": "Jane Doe"
}
],
"metrics": [
{
"metric": "open_profit_owed",
"label": "Open profit owed",
"unit": "usd",
"description": "Profit above the starting balance on active funded accounts"
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Each figure can have one limit",
"code": "DUPLICATE_METRIC"
}{
"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": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "Failed to save the alert limits",
"code": "ALERT_LIMITS_ERROR"
}