Get long vs short positioning over time
Your traders’ gross long and gross short exposure over the last hour, day or week, at the end of each time bucket: for the whole organization, and for the products you ask for with product (size, exposure and the number of accounts on each side).
Positions are rebuilt from executions, starting carryDays before the range, and valued at your traders’ latest execution price on each contract. A position opened before that is not included, so for the current figures use GET /organization/risk/positioning; together they give a chart that ends at the live book.
With assetClass or market, only positions and executions in contracts of those markets count. The positioning read’s instruments carry market and assetClass, so you can filter the live book the same way.
Results are shared for up to 30 seconds (1h), 60 seconds (24h) or 5 minutes (7d) per set of account types and plans. About 60 requests per minute per organization.
Example
curl "https://api.hyperprop.com/platform/v1/organization/risk/positioning/history?range=24h&product=MNQ" \
-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/history \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/positioning/history"
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/history', 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/history",
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/history"
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/history")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/positioning/history")
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",
"range": "24h",
"bucketSeconds": 300,
"since": "2026-11-02T14:45:00.000Z",
"until": "2026-11-03T14:45:00.000Z",
"asOf": "2026-11-03T14:41:07.118Z",
"carryDays": 2,
"marketFilter": {
"assetClass": "future",
"markets": [
"CME",
"CBOT"
]
},
"times": [
"2026-11-02T14:50:00.000Z",
"2026-11-02T14:55:00.000Z",
"2026-11-02T15:00:00.000Z"
],
"totals": {
"longNotional": [
182400,
190150,
176820
],
"shortNotional": [
78200,
84300,
113400
],
"netNotional": [
104200,
105850,
63420
]
},
"products": [
{
"productKey": "MNQ",
"rootSymbol": "MNQ",
"name": "Micro E-mini Nasdaq-100",
"productGroup": "equity_index",
"sizeUnit": "contracts",
"longQuantity": [
42,
45,
40
],
"shortQuantity": [
18,
20,
26
],
"longNotional": [
182400,
190150,
176820
],
"shortNotional": [
78200,
84300,
113400
],
"longAccounts": [
12,
13,
11
],
"shortAccounts": [
6,
7,
9
]
}
],
"productIndex": [
{
"productKey": "MNQ",
"rootSymbol": "MNQ",
"name": "Micro E-mini Nasdaq-100",
"productGroup": "equity_index",
"peakGrossNotional": 412800
}
],
"fills": 18342,
"live": {
"at": "2026-11-13T15:41:07.118Z",
"historyAsOf": "2026-11-13T15:40:02.000Z",
"historyCompleteUntil": "2026-11-13T15:39:00.000Z",
"totals": {
"longNotional": 123,
"shortNotional": 123,
"netNotional": 123
},
"products": [
{}
]
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Unknown market: CMX. Use CME, CBOT, NYMEX, COMEX, HDL, BINANCE, HYPERLIQUID",
"code": "INVALID_MARKET"
}{
"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/history \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/positioning/history"
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/history', 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/history",
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/history"
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/history")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/positioning/history")
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",
"range": "24h",
"bucketSeconds": 300,
"since": "2026-11-02T14:45:00.000Z",
"until": "2026-11-03T14:45:00.000Z",
"asOf": "2026-11-03T14:41:07.118Z",
"carryDays": 2,
"marketFilter": {
"assetClass": "future",
"markets": [
"CME",
"CBOT"
]
},
"times": [
"2026-11-02T14:50:00.000Z",
"2026-11-02T14:55:00.000Z",
"2026-11-02T15:00:00.000Z"
],
"totals": {
"longNotional": [
182400,
190150,
176820
],
"shortNotional": [
78200,
84300,
113400
],
"netNotional": [
104200,
105850,
63420
]
},
"products": [
{
"productKey": "MNQ",
"rootSymbol": "MNQ",
"name": "Micro E-mini Nasdaq-100",
"productGroup": "equity_index",
"sizeUnit": "contracts",
"longQuantity": [
42,
45,
40
],
"shortQuantity": [
18,
20,
26
],
"longNotional": [
182400,
190150,
176820
],
"shortNotional": [
78200,
84300,
113400
],
"longAccounts": [
12,
13,
11
],
"shortAccounts": [
6,
7,
9
]
}
],
"productIndex": [
{
"productKey": "MNQ",
"rootSymbol": "MNQ",
"name": "Micro E-mini Nasdaq-100",
"productGroup": "equity_index",
"peakGrossNotional": 412800
}
],
"fills": 18342,
"live": {
"at": "2026-11-13T15:41:07.118Z",
"historyAsOf": "2026-11-13T15:40:02.000Z",
"historyCompleteUntil": "2026-11-13T15:39:00.000Z",
"totals": {
"longNotional": 123,
"shortNotional": 123,
"netNotional": 123
},
"products": [
{}
]
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Unknown market: CMX. Use CME, CBOT, NYMEX, COMEX, HDL, BINANCE, HYPERLIQUID",
"code": "INVALID_MARKET"
}{
"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"
}