Get live positioning across all accounts
Every open position of your organization in one call, each with the account’s plan, type and trader, plus the contract details needed to group and value exposure.
Use it to build an aggregated book (net long/short per product, by plan or account type) and keep it current with the real-time trading stream (POST .../trading-accounts/stream-token, connect with v=2): connect first, then read with fresh=true, and apply each PositionUpdate whose state_version is not lower than the position’s stateVersion in the same stateEpoch. When the stream reports an account this read did not include, read it with accountId.
When source is live, the answer already reflects every change within about a second, with or without fresh. Otherwise results without fresh are shared for up to 15 seconds, and newly created accounts appear within a minute. About 60 requests per minute per organization.
Example
curl "https://api.hyperprop.com/platform/v1/organization/risk/positioning" \
-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/positioning \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/positioning"
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/positioning', 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/positioning",
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/positioning"
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/positioning")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/positioning")
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",
"asOf": "2026-11-03T14:41:07.118Z",
"source": "live",
"accounts": [
{
"accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-50K-000123",
"customerId": "crm-cust-4471",
"status": "in_progress",
"accountType": "sim_funded",
"initialBalance": 50000,
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "50K Pro",
"accountSize": 50000,
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"traderName": "Jane Trader",
"traderEmail": "jane@example.com",
"stateEpoch": 1761847200123,
"stateVersion": 57,
"positions": [
{
"positionId": "3f6c1d2e-8a4b-5c7d-9e0f-1a2b3c4d5e6f",
"contract": "MNQZ6",
"side": "long",
"quantity": 2,
"avgEntryPrice": 21012.25,
"unrealizedPnl": 41,
"realizedPnl": 0,
"openedAt": "2026-11-03T14:30:00.000Z",
"updatedAt": "2026-11-03T14:35:12.000Z",
"stateVersion": 57,
"stateEpoch": 1761847200123
}
]
}
],
"unavailable": [
"<string>"
],
"instruments": {},
"summary": {
"accountsScanned": 1840,
"accountsWithPositions": 212,
"unavailable": 0,
"truncated": false
}
}
}{
"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"
}{
"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/positioning \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/positioning"
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/positioning', 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/positioning",
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/positioning"
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/positioning")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/positioning")
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",
"asOf": "2026-11-03T14:41:07.118Z",
"source": "live",
"accounts": [
{
"accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"accountNumber": "ACC-50K-000123",
"customerId": "crm-cust-4471",
"status": "in_progress",
"accountType": "sim_funded",
"initialBalance": 50000,
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "50K Pro",
"accountSize": 50000,
"traderId": "2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b",
"traderName": "Jane Trader",
"traderEmail": "jane@example.com",
"stateEpoch": 1761847200123,
"stateVersion": 57,
"positions": [
{
"positionId": "3f6c1d2e-8a4b-5c7d-9e0f-1a2b3c4d5e6f",
"contract": "MNQZ6",
"side": "long",
"quantity": 2,
"avgEntryPrice": 21012.25,
"unrealizedPnl": 41,
"realizedPnl": 0,
"openedAt": "2026-11-03T14:30:00.000Z",
"updatedAt": "2026-11-03T14:35:12.000Z",
"stateVersion": 57,
"stateEpoch": 1761847200123
}
]
}
],
"unavailable": [
"<string>"
],
"instruments": {},
"summary": {
"accountsScanned": 1840,
"accountsWithPositions": 212,
"unavailable": 0,
"truncated": false
}
}
}{
"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"
}{
"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"
}