Get active traders
Returns how many traders had a live account at any time in a period, the same figure for the period of equal length before it, and the number of traders live on each day.
A live account is one with status in_progress or not_started. An account
counts as live from its createdAt until it ended (passed, failed, expired
or turned inactive), so a trader whose account failed during the period still
counts for that period. Each trader counts once, however many accounts they
hold. type counts only accounts of that type.
Previous period: previousActiveTraders covers the same length of time
directly before startDate (null without one).
Range limit: startDate to endDate (or to now) may span at most
1096 days (three years); a longer range returns 400 DATE_RANGE_TOO_LONG.
For a longer view, leave out startDate or request consecutive ranges.
Daily values: activity has one point per UTC day, from the start of the
previous period to endDate (the 365 days up to endDate without a
startDate), counting the traders with a live account at any time that day.
All traders: allTimeTraders is every trader added to your organization,
whatever their accounts, the same population as summary.totalTraders in
GET /organization/analytics.
Figures may be up to a few minutes old. A range that ends now (its end is less than an hour ago, or later) is read in full hours: the start moves back to the full hour and the end covers everything up to now. A range that ended earlier is read exactly as sent.
Example:
GET /organization/trading-accounts/active-traders?startDate=2026-07-01&endDate=2026-07-31
Permissions: requires view access to “Traders & accounts”.
Authentication: send your organization API key in the X-API-Key header.
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/trading-accounts/active-traders \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/active-traders"
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/trading-accounts/active-traders', 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/trading-accounts/active-traders",
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/trading-accounts/active-traders"
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/trading-accounts/active-traders")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/active-traders")
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>",
"organizationName": "<string>",
"generatedAt": "<string>",
"filters": {
"startDate": "<string>",
"endDate": "<string>",
"type": "evaluation"
},
"activeTraders": 412,
"previousActiveTraders": 380,
"allTimeTraders": 1291,
"activity": [
{
"date": "2026-07-20",
"activeTraders": 298
},
{
"date": "2026-07-21",
"activeTraders": 305
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "The range from startDate to endDate may be at most 1096 days",
"code": "DATE_RANGE_TOO_LONG"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The report took too long right now; try again later",
"code": "REPORT_TIMEOUT"
}{
"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/trading-accounts/active-traders \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts/active-traders"
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/trading-accounts/active-traders', 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/trading-accounts/active-traders",
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/trading-accounts/active-traders"
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/trading-accounts/active-traders")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/trading-accounts/active-traders")
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>",
"organizationName": "<string>",
"generatedAt": "<string>",
"filters": {
"startDate": "<string>",
"endDate": "<string>",
"type": "evaluation"
},
"activeTraders": 412,
"previousActiveTraders": 380,
"allTimeTraders": 1291,
"activity": [
{
"date": "2026-07-20",
"activeTraders": 298
},
{
"date": "2026-07-21",
"activeTraders": 305
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "The range from startDate to endDate may be at most 1096 days",
"code": "DATE_RANGE_TOO_LONG"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The report took too long right now; try again later",
"code": "REPORT_TIMEOUT"
}{
"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"
}