Organization

Get trading accounts for your organization

Retrieve all trading accounts for your organization with powerful filtering and search.

What is a trading account? A trading account represents a trader’s evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules.

Account types:

Type	Description
`evaluation`	Challenge account where trader must hit profit target
`sim_funded`	Simulated funded account after passing evaluation

Account statuses:

Status	Description
`not_started`	Account created but trader hasn’t begun trading
`in_progress`	Trader is actively trading
`passed`	Trader hit profit target and passed the evaluation
`failed`	Trader violated a rule (max loss, drawdown, etc.)
`expired`	Evaluation period ended without passing

What you get for each account:

Account details (number, type, status, balances)
Performance data and high water mark
Trading plan and rules applied
Trader info (your customer’s email and name)
Linked Hyperprop user (or the one-time importKey while still unlinked)
Purchase details (what they paid)
Custom metadata (any JSON data you need)

Search: The search parameter is flexible and matches:

Account number (partial match): ?search=APEX-100K
Trader email (partial match): ?search=john@
Trader name (partial match): ?search=John
Account ID (exact match): ?search=7c9e6679-7425-40de-944b-e07fc1f90ae7
User ID (exact match): ?search=f994bc02-343c-4026-8a57-afc085eca8d5

Lookup by your own customer ID: ?customerId=mffu-cust-4471 returns all accounts of the customer whose customerId you set at creation (or via PATCH) — an indexed, exact-match, deterministic lookup for reconciliation. (?externalRef= still works as a deprecated alias.)

Example queries:

# Find all active evaluations
GET /organization/trading-accounts?type=evaluation&status=in_progress

# Search for a specific trader
GET /organization/trading-accounts?search=john@example.com

# Get all passed accounts this month
GET /organization/trading-accounts?status=passed&startDate=2025-01-01&endDate=2025-01-31

# Find high-priority accounts that are in progress
GET /organization/trading-accounts?metadata=priority:high&status=in_progress

# Page through results (page 2, 25 per page)
GET /organization/trading-accounts?limit=25&offset=25

Use cases:

Monitor active evaluations in real-time
Find accounts for a specific trader
Generate pass/fail reports
Track VIP or promotional accounts
Audit account history for compliance

GET

organization

trading-accounts

Get trading accounts for your organization

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

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts', 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",
  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/trading-accounts"

	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/trading-accounts")

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": "FakePropFirm",
    "accounts": [
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "accountNumber": "ACC-7845KXPQ",
        "type": "evaluation",
        "status": "in_progress",
        "initialBalance": 50000,
        "currentBalance": 52150,
        "highWaterMark": 53200,
        "dailyStartingBalance": 51800,
        "startedAt": "2026-02-01T09:00:00.000Z",
        "completedAt": null,
        "violationReason": null,
        "metadata": {
          "source": "affiliate_program"
        },
        "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
        "userEmail": "trader@example.com",
        "userAvatarUrl": "https://api.dicebear.com/9.x/glass/svg?seed=trader",
        "tradingPlan": {
          "id": "09c93da5-f057-4cc5-82da-ff9220292c94",
          "name": "50K Challenge",
          "accountSize": 50000
        },
        "tradingRule": {
          "id": "6bec94a1-425b-47be-bb41-a80e3140e2e7",
          "name": "Standard Rules",
          "profitTarget": 4000,
          "maxLoss": 2500,
          "maxDrawdown": 5,
          "drawdownType": "static"
        },
        "trader": {
          "email": "john.smith@email.com",
          "name": "John Smith"
        },
        "purchase": {
          "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "purchaseDate": "2026-01-28T10:00:00.000Z",
          "pricePaid": 299,
          "currency": "USD",
          "metadata": {
            "stripePaymentId": "pi_3ABC123"
          }
        },
        "createdAt": "2026-01-28T10:00:00.000Z",
        "updatedAt": "2026-02-17T14:30:00.000Z"
      }
    ],
    "pagination": {
      "total": 142,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This endpoint is only available for organization users",
  "code": "NOT_ORGANIZATION_USER"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

string

Search by account number, trader email/name, account ID, or user ID

type

enum<string>

Filter by account type

Available options:

evaluation,

sim_funded,

competition

status

enum<string>

Filter by account status

Available options:

not_started,

in_progress,

passed,

failed,

expired

metadata

string

Filter by metadata key:value (e.g., "vip:true", "source:affiliate")

customerId

string

Exact match on the customerId you set at account creation (or via PATCH). Deterministic lookup of all accounts belonging to one of your customers.

Maximum string length: 255

externalRef

string

DEPRECATED alias for customerId — use customerId instead.

Maximum string length: 255

unlinked

boolean

true = only accounts with no trader attached yet (their one-time importKey is included in each row); false = only linked accounts. Omit for both.

startDate

string

Only include accounts created from this date onwards

endDate

string

Only include accounts created up to this date

limit

integer

default:50

Results per page (default: 50, max: 100)

Required range: 1 <= x <= 100

offset

integer

default:0

Skip this many results (for pagination)

Required range: x >= 0

cursor

string

Cursor for pagination. Pass the nextCursor value from the previous response to get the next page. When using cursor, do not send offset — it will be ignored.

How it works: The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages.

Backwards compatible: If you don't send a cursor, offset/limit pagination works as before.

Response

Success - Returns paginated list of trading accounts

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
  "organizationName": "FakePropFirm",
  "accounts": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "accountNumber": "ACC-7845KXPQ",
      "type": "evaluation",
      "status": "in_progress",
      "initialBalance": 50000,
      "currentBalance": 52150,
      "highWaterMark": 53200,
      "dailyStartingBalance": 51800,
      "startedAt": "2026-02-01T09:00:00.000Z",
      "completedAt": null,
      "violationReason": null,
      "metadata": { "source": "affiliate_program" },
      "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
      "userEmail": "trader@example.com",
      "userAvatarUrl": "https://api.dicebear.com/9.x/glass/svg?seed=trader",
      "tradingPlan": {
        "id": "09c93da5-f057-4cc5-82da-ff9220292c94",
        "name": "50K Challenge",
        "accountSize": 50000
      },
      "tradingRule": {
        "id": "6bec94a1-425b-47be-bb41-a80e3140e2e7",
        "name": "Standard Rules",
        "profitTarget": 4000,
        "maxLoss": 2500,
        "maxDrawdown": 5,
        "drawdownType": "static"
      },
      "trader": {
        "email": "john.smith@email.com",
        "name": "John Smith"
      },
      "purchase": {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "purchaseDate": "2026-01-28T10:00:00.000Z",
        "pricePaid": 299,
        "currency": "USD",
        "metadata": { "stripePaymentId": "pi_3ABC123" }
      },
      "createdAt": "2026-01-28T10:00:00.000Z",
      "updatedAt": "2026-02-17T14:30:00.000Z"
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 50,
    "offset": 0,
    "hasMore": true
  }
}

⌘I

Get trading accounts for your organization

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

import requests

url = "https://api.hyperprop.com/platform/v1/organization/trading-accounts"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.hyperprop.com/platform/v1/organization/trading-accounts', 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",
  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/trading-accounts"

	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/trading-accounts")

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": "FakePropFirm",
    "accounts": [
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "accountNumber": "ACC-7845KXPQ",
        "type": "evaluation",
        "status": "in_progress",
        "initialBalance": 50000,
        "currentBalance": 52150,
        "highWaterMark": 53200,
        "dailyStartingBalance": 51800,
        "startedAt": "2026-02-01T09:00:00.000Z",
        "completedAt": null,
        "violationReason": null,
        "metadata": {
          "source": "affiliate_program"
        },
        "userId": "f994bc02-343c-4026-8a57-afc085eca8d5",
        "userEmail": "trader@example.com",
        "userAvatarUrl": "https://api.dicebear.com/9.x/glass/svg?seed=trader",
        "tradingPlan": {
          "id": "09c93da5-f057-4cc5-82da-ff9220292c94",
          "name": "50K Challenge",
          "accountSize": 50000
        },
        "tradingRule": {
          "id": "6bec94a1-425b-47be-bb41-a80e3140e2e7",
          "name": "Standard Rules",
          "profitTarget": 4000,
          "maxLoss": 2500,
          "maxDrawdown": 5,
          "drawdownType": "static"
        },
        "trader": {
          "email": "john.smith@email.com",
          "name": "John Smith"
        },
        "purchase": {
          "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "purchaseDate": "2026-01-28T10:00:00.000Z",
          "pricePaid": 299,
          "currency": "USD",
          "metadata": {
            "stripePaymentId": "pi_3ABC123"
          }
        },
        "createdAt": "2026-01-28T10:00:00.000Z",
        "updatedAt": "2026-02-17T14:30:00.000Z"
      }
    ],
    "pagination": {
      "total": 142,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired session"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "This endpoint is only available for organization users",
  "code": "NOT_ORGANIZATION_USER"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Get trading accounts for your organization

Authorizations

Query Parameters

Response