Skip to main content
GET
Get trading accounts 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

Searches the whole organization, not just the current page. Case-insensitive; minimum 2 characters. Matches account number, customer ID, import key and your external purchase ID (full or partial), account ID (full or partial, at least 4 hexadecimal characters), the start of the trader's user ID or organizationUserId, the Hyperprop trader ID ("#00012340" or just the digits), and the trader's email (sign-in email or the one you supplied), full name, username, display name, profile name and external user ID (partial). Metadata is not searched; use the metadata parameter to filter by key:value. Results are ranked: exact account number, account ID, customer ID or import key first, then account number or account ID prefix, then substring, then trader-level matches; the other filters apply to the whole ranked result set, and pagination and total apply to the filtered result (at most 1,000 matches). A search pages with offset; it returns no nextCursor.

type
enum<string>

Filter by account type

Available options:
evaluation,
sim_funded,
competition
status
enum<string>

Filter by account status. inactive = turned off by your firm (see POST /trading-accounts/{accountId}/deactivate).

Available options:
not_started,
in_progress,
inactive,
passed,
failed,
expired
planId
string

Filter by trading plan (the plan the account was purchased under)

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, except for read-only API keys); 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.

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

Success - Returns paginated list of trading accounts

success
boolean
Example:

true

data
object
Example: