Organization

Get traders for your organization

Returns all traders who have accounts with your organization.

Search examples:

?search=john - Find by partial username, displayName, or name
?search=john@example.com - Find by partial email
?search=550e8400-e29b-41d4-a716-446655440000 - Find by exact userId

Lookup by your own reference:

?externalUserId=mffu-user-4471 - Find the trader by the external ID you assigned (set via traderExternalId on POST /trading-accounts, or via PUT /traders/). Exact match, indexed — no email round-trip needed.

Metadata filter: Filter traders by any key:value in their metadata:

?metadata=customerTier:gold - Find gold tier customers
?metadata=vip:true - Find VIP traders

Combined filters:

?search=john&metadata=customerTier:gold
?search=john&startDate=2025-01-01&endDate=2025-01-31
?metadata=source:referral&startDate=2025-01-01&limit=10

GET

organization

traders

Get traders for your organization

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

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

fetch('https://api.hyperprop.com/platform/v1/organization/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/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 => [
    "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/traders"

	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/traders")

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",
    "traders": [
      {
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "email": "trader@example.com",
        "externalUserId": "mffu-user-4471",
        "emailVerified": true,
        "lastSignIn": "2025-01-25T14:30:00.000Z",
        "registeredAt": "2025-01-01T10:00:00.000Z",
        "joinedAt": "2025-01-15T10:00:00.000Z",
        "metadata": {
          "customerTier": "gold",
          "lifetimeValue": 2500
        },
        "profile": {
          "username": "john_trader",
          "displayName": "John Trader",
          "name": "John",
          "avatarUrl": "https://example.com/avatar.jpg",
          "isPublic": true,
          "createdAt": "2025-01-10T08:00:00.000Z"
        }
      }
    ],
    "pagination": {
      "total": 150,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "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 email, username, displayName, name (partial match) or userId (exact match)

externalUserId

string

Exact match on the external reference you set for the trader (via traderExternalId on account creation or PUT /traders/{traderId}). Deterministic lookup by your own user ID.

Maximum string length: 255

metadata

string

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

startDate

string

Filter traders who joined on or after this date (ISO 8601 format)

endDate

string

Filter traders who joined on or before this date (ISO 8601 format)

limit

integer

default:50

Number of traders to return (max 100)

Required range: 1 <= x <= 100

offset

integer

default:0

Offset 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

Traders retrieved successfully

success

boolean

Example:

true

data

object

Show child attributes

Example:

{
  "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
  "organizationName": "FakePropFirm",
  "traders": [
    {
      "userId": "550e8400-e29b-41d4-a716-446655440000",
      "email": "trader@example.com",
      "externalUserId": "mffu-user-4471",
      "emailVerified": true,
      "lastSignIn": "2025-01-25T14:30:00.000Z",
      "registeredAt": "2025-01-01T10:00:00.000Z",
      "joinedAt": "2025-01-15T10:00:00.000Z",
      "metadata": {
        "customerTier": "gold",
        "lifetimeValue": 2500
      },
      "profile": {
        "username": "john_trader",
        "displayName": "John Trader",
        "name": "John",
        "avatarUrl": "https://example.com/avatar.jpg",
        "isPublic": true,
        "createdAt": "2025-01-10T08:00:00.000Z"
      }
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "offset": 0,
    "hasMore": true
  }
}

⌘I

Get traders for your organization

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

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

fetch('https://api.hyperprop.com/platform/v1/organization/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/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 => [
    "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/traders"

	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/traders")

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",
    "traders": [
      {
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "email": "trader@example.com",
        "externalUserId": "mffu-user-4471",
        "emailVerified": true,
        "lastSignIn": "2025-01-25T14:30:00.000Z",
        "registeredAt": "2025-01-01T10:00:00.000Z",
        "joinedAt": "2025-01-15T10:00:00.000Z",
        "metadata": {
          "customerTier": "gold",
          "lifetimeValue": 2500
        },
        "profile": {
          "username": "john_trader",
          "displayName": "John Trader",
          "name": "John",
          "avatarUrl": "https://example.com/avatar.jpg",
          "isPublic": true,
          "createdAt": "2025-01-10T08:00:00.000Z"
        }
      }
    ],
    "pagination": {
      "total": 150,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "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 traders for your organization

Authorizations

Query Parameters

Response