Skip to main content
GET
Get open positions and equity for many accounts

Authorizations

X-API-Key
string
header
required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Query Parameters

accountId
string

Specific accounts: one account ID or a comma-separated list (max 200). Every ID must belong to your organization, otherwise 404 ACCOUNT_NOT_FOUND. status, limit and cursor do not apply.

status
string

Account statuses to include, comma-separated. Default: not_started,in_progress,inactive, every account that can hold positions.

Pattern: ^(not_started|in_progress|inactive|passed|failed|expired)(,(not_started|in_progress|inactive|passed|failed|expired))*$
openOnly
boolean
default:false

true: leave out accounts without open positions. A page can then hold fewer than limit accounts; keep following nextCursor until it is null.

limit
integer
default:100

Accounts per page (default 100, max 200)

Required range: 1 <= x <= 200
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

Accounts retrieved

success
boolean
Example:

true

data
object