Skip to main content
GET
Get trader behavior by plan

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.

Headers

If-None-Match
string

Optional. The ETag of the answer you already have. When the answer would be the same, the response is 304 without a body.

Query Parameters

startDate
string

Start of the range (inclusive), ISO 8601. Defaults to 30 days before endDate.

endDate
string

End of the range (exclusive), ISO 8601. Defaults to now. At most 62 days after startDate.

accountType
enum<string>

Only accounts of this type: evaluation, funded (simulated funded included) or competition. Defaults to every type.

Available options:
evaluation,
funded,
competition
planId
string

Only accounts bought under this plan

Response

Trade behavior, trader types and outcomes per plan and account type

success
boolean
Example:

true

data
object