Skip to main content
GET
Get traders for your organization

Authorizations

X-API-Key
string
header
required

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.

Query Parameters

Matches email, username, display name, profile name, full name, external user ID (partial, case-insensitive), user ID (full or partial), the Hyperprop trader ID ("#00012340" or the digits), any of the trader's account numbers or account IDs, and metadata text. Results are ranked: exact email/ID first, then prefix, then substring, then account-level matches.

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.

A cursor that was not returned by this endpoint, or one from a request with a different sort, is rejected with 400.

Maximum string length: 512

Response

Traders retrieved successfully

success
boolean
Example:

true

data
object
Example: