Organization

Get organization analytics

Retrieve aggregate analytics and statistics for your organization’s trading accounts in a single call.

What you get

Section	Description
summary	Total accounts, total traders, active lockouts
accounts.byStatus	Counts per status: not_started, in_progress, passed, failed, expired
accounts.byType	Counts per type: evaluation, sim_funded, competition
accounts.passRate	Pass rate = passed / (passed + failed) × 100
accounts.passRateIncludingExpired	Stricter: passed / (passed + failed + expired) × 100
accounts.avgCompletionDays	Average days to complete (pass or fail)
accounts.avgTimeToPassDays	Average days to pass
revenue	Total revenue, purchase count, average per account
payouts	Total paid out, payout count, average/largest payout, payout ratio (paid out ÷ revenue)
risk	Open profit liability across in-progress accounts, accounts in profit vs drawdown, lockout breakdown
violations	Violation reason breakdown for failed accounts
performance	Average P&L, drawdown, trades, win rate

Filters

Parameter	Type	Example	Description
`startDate`	ISO 8601	`2026-01-01`	Only accounts created on or after this date
`endDate`	ISO 8601	`2026-03-31`	Only accounts created on or before this date
`type`	string	`evaluation`	Only accounts of this type (`evaluation`, `sim_funded`, `competition`)

All filters are optional. Omit all for all-time analytics across all account types.

Null values

Fields like passRate, avgCompletionDays, avgRevenuePerAccount, and performance return null when there is insufficient data to compute them (e.g. no completed accounts, no purchases, no performance data). This avoids misleading zero values.

Error codes

HTTP	Code	When
400	`VALIDATION_ERROR`	startDate/endDate is not valid ISO 8601, or type is not evaluation, sim_funded, or competition
401	`UNAUTHORIZED`	Missing or invalid Bearer token / API key
403	`FORBIDDEN`	Token does not belong to any organization
500	`ANALYTICS_ERROR`	Internal error (database query failure)

Examples

# All-time analytics (API key)
curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics" \
  -H "X-API-Key: hp_live_your_key_here"

# Q1 2026 evaluations only (API key)
curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics?startDate=2026-01-01&endDate=2026-03-31&type=evaluation" \
  -H "X-API-Key: hp_live_your_key_here"

# Using Bearer token (dashboard)
curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics" \
  -H "Authorization: Bearer eyJhbGciOi..."

Authentication: Accepts either Authorization: Bearer <jwt> (dashboard) or X-API-Key: hp_live_... (programmatic).

GET

organization

analytics

Get organization analytics

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/analytics \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/analytics', 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/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "Apex Trading Co",
    "generatedAt": "2026-03-29T15:00:00.000Z",
    "filters": {
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-03-31T23:59:59.999Z",
      "type": "evaluation"
    },
    "summary": {
      "totalAccounts": 1250,
      "totalTraders": 892,
      "activeLockouts": 15
    },
    "accounts": {
      "byStatus": {
        "notStarted": 120,
        "inProgress": 450,
        "passed": 180,
        "failed": 420,
        "expired": 80
      },
      "byType": {
        "evaluation": 900,
        "sim_funded": 300,
        "competition": 50
      },
      "passRate": 30,
      "passRateIncludingExpired": 24,
      "avgCompletionDays": 12.5,
      "avgTimeToPassDays": 18.3
    },
    "revenue": {
      "totalRevenue": 187500,
      "currency": "USD",
      "totalPurchases": 1250,
      "avgRevenuePerAccount": 150
    },
    "payouts": {
      "totalPaidOut": 48200,
      "currency": "USD",
      "payoutCount": 31,
      "avgPayout": 1554.84,
      "largestPayout": 5000,
      "accountsWithPayouts": 18,
      "payoutRatio": 25.7
    },
    "risk": {
      "openProfitLiability": 63400,
      "accountsInProfit": 120,
      "accountsInDrawdown": 210,
      "activeLockouts": 15,
      "lockoutsByMode": {
        "admin": 5,
        "trade_clock": 8,
        "timed": 2
      },
      "lockoutsByLockedBy": {
        "admin": 5,
        "user": 8,
        "system": 2
      }
    },
    "violations": {
      "Daily Loss exceeded: $501.50 loss >= $500 limit": 180,
      "Max Loss exceeded: $2,550 loss >= $2,500 limit": 120,
      "Max Drawdown exceeded": 95,
      "unknown": 25
    },
    "performance": {
      "avgPnl": 245.5,
      "avgMaxDrawdown": 1250.75,
      "avgTradesPerAccount": 47.3,
      "avgWinRate": 38.2
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Date must be a valid ISO 8601 string (e.g. 2026-01-01 or 2026-01-01T00:00:00.000Z)",
  "code": "VALIDATION_ERROR"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "You do not belong to any organization",
  "code": "FORBIDDEN"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An error occurred fetching analytics",
  "code": "ANALYTICS_ERROR"
}

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Query Parameters

startDate

string

Filter accounts created on or after this date (ISO 8601). Examples: 2026-01-01, 2026-01-01T00:00:00.000Z

endDate

string

Filter accounts created on or before this date (ISO 8601). Examples: 2026-03-31, 2026-03-31T23:59:59.999Z

type

enum<string>

Filter by account type. Only accounts of this type are included in all metrics.

Available options:

evaluation,

sim_funded,

competition

Response

Success — Returns aggregate analytics for your organization

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Get organization analytics

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/analytics \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/analytics', 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/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "Apex Trading Co",
    "generatedAt": "2026-03-29T15:00:00.000Z",
    "filters": {
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-03-31T23:59:59.999Z",
      "type": "evaluation"
    },
    "summary": {
      "totalAccounts": 1250,
      "totalTraders": 892,
      "activeLockouts": 15
    },
    "accounts": {
      "byStatus": {
        "notStarted": 120,
        "inProgress": 450,
        "passed": 180,
        "failed": 420,
        "expired": 80
      },
      "byType": {
        "evaluation": 900,
        "sim_funded": 300,
        "competition": 50
      },
      "passRate": 30,
      "passRateIncludingExpired": 24,
      "avgCompletionDays": 12.5,
      "avgTimeToPassDays": 18.3
    },
    "revenue": {
      "totalRevenue": 187500,
      "currency": "USD",
      "totalPurchases": 1250,
      "avgRevenuePerAccount": 150
    },
    "payouts": {
      "totalPaidOut": 48200,
      "currency": "USD",
      "payoutCount": 31,
      "avgPayout": 1554.84,
      "largestPayout": 5000,
      "accountsWithPayouts": 18,
      "payoutRatio": 25.7
    },
    "risk": {
      "openProfitLiability": 63400,
      "accountsInProfit": 120,
      "accountsInDrawdown": 210,
      "activeLockouts": 15,
      "lockoutsByMode": {
        "admin": 5,
        "trade_clock": 8,
        "timed": 2
      },
      "lockoutsByLockedBy": {
        "admin": 5,
        "user": 8,
        "system": 2
      }
    },
    "violations": {
      "Daily Loss exceeded: $501.50 loss >= $500 limit": 180,
      "Max Loss exceeded: $2,550 loss >= $2,500 limit": 120,
      "Max Drawdown exceeded": 95,
      "unknown": 25
    },
    "performance": {
      "avgPnl": 245.5,
      "avgMaxDrawdown": 1250.75,
      "avgTradesPerAccount": 47.3,
      "avgWinRate": 38.2
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Date must be a valid ISO 8601 string (e.g. 2026-01-01 or 2026-01-01T00:00:00.000Z)",
  "code": "VALIDATION_ERROR"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "You do not belong to any organization",
  "code": "FORBIDDEN"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An error occurred fetching analytics",
  "code": "ANALYTICS_ERROR"
}

Platform API

Trade API

Market Data API

Get organization analytics

What you get

Filters

Null values

Error codes

Examples

Authorizations

Query Parameters

Response