Read exposure and concentration
What the firm’s traders hold right now and how concentrated it is: per market, long, short and net size in full-size contracts (10 MNQ = 1 NQ), notional, open profit or loss, and the share held by the top largest traders; firm-wide, the open profit owed (the sum of every account’s open profit where it is in profit) and the share of the largest traders. With fundedOnly=true only funded accounts count.
Each market with a limit set (PUT /risk/exposure-limits) shows how much of it the net size uses and whether it is above it. Limits are for monitoring only; nothing is enforced. The live positions are a few seconds old; complete is false when some accounts could not be read.
curl "https://api.hyperprop.com/platform/v1/organization/risk/exposure?fundedOnly=true&top=10" \
-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/exposure \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/exposure"
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/exposure', 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/exposure",
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/exposure"
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/exposure")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/exposure")
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>",
"limitsAvailable": true,
"asOf": "<string>",
"fundedOnly": true,
"top": 10,
"complete": true,
"summary": {
"accounts": 312,
"traders": 280,
"grossNotional": 48200000,
"netNotional": 6100000,
"openProfitOwed": 182400,
"openPnl": 96300,
"topTradersShare": 0.31,
"unavailableAccounts": 0,
"limitsBreached": 1
},
"products": [
{
"underlying": "NQ",
"productGroup": "equity_index",
"long": 41.3,
"short": 12,
"net": 29.3,
"grossNotional": 123,
"netNotional": 123,
"openPnl": 123,
"accounts": 123,
"traders": 123,
"topTradersShare": 0.44,
"limit": {
"maxNetContracts": 25,
"usedShare": 1.172,
"breached": true
}
}
],
"topTraders": [
{
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"traderName": "<string>",
"grossNotional": 123,
"share": 0.06,
"openPnl": 123,
"accounts": [
{
"accountId": "<string>",
"accountNumber": "<string>",
"customerId": "<string>",
"accountType": "<string>"
}
],
"underlyings": [
"ES",
"NQ"
]
}
]
}
}{
"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/exposure \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/exposure"
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/exposure', 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/exposure",
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/exposure"
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/exposure")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/exposure")
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>",
"limitsAvailable": true,
"asOf": "<string>",
"fundedOnly": true,
"top": 10,
"complete": true,
"summary": {
"accounts": 312,
"traders": 280,
"grossNotional": 48200000,
"netNotional": 6100000,
"openProfitOwed": 182400,
"openPnl": 96300,
"topTradersShare": 0.31,
"unavailableAccounts": 0,
"limitsBreached": 1
},
"products": [
{
"underlying": "NQ",
"productGroup": "equity_index",
"long": 41.3,
"short": 12,
"net": 29.3,
"grossNotional": 123,
"netNotional": 123,
"openPnl": 123,
"accounts": 123,
"traders": 123,
"topTradersShare": 0.44,
"limit": {
"maxNetContracts": 25,
"usedShare": 1.172,
"breached": true
}
}
],
"topTraders": [
{
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"traderName": "<string>",
"grossNotional": 123,
"share": 0.06,
"openPnl": 123,
"accounts": [
{
"accountId": "<string>",
"accountNumber": "<string>",
"customerId": "<string>",
"accountType": "<string>"
}
],
"underlyings": [
"ES",
"NQ"
]
}
]
}
}{
"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"
}