Skip to main content
GET
Get live positioning across all accounts

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

accountId
string

Comma-separated account IDs, at most 200: return these accounts, flat ones included, instead of every open position

Maximum string length: 8000
fresh
boolean
default:false

true: read positions taken no earlier than one second before the request, instead of the result shared for a few seconds. Use it right after connecting to the trading stream, so no change falls between the two.

Response

Open positions with account, plan, trader and contract details

success
boolean
Example:

true

data
object