Skip to main content
GET
Get live exposure by product and trader

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

accountType
string

Comma-separated account types: evaluation, sim_funded, competition

Maximum string length: 100
planId
string

Comma-separated plan IDs, at most 50; none for accounts without a plan

Maximum string length: 2000
traders
boolean
default:false

Include exposure per trader

traderLimit
integer
default:50

With traders=true: how many traders, largest gross exposure first

Required range: 1 <= x <= 500
assetClass
enum<string>

Only one kind of market: future (CME Group futures) or perpetual (perpetuals). Omit for both

Available options:
future,
perpetual
market
string

Comma-separated markets your organization is enabled for: futures CME, CBOT, NYMEX, COMEX; perpetuals HDL, BINANCE, HYPERLIQUID. With assetClass, every market must be of that class

Maximum string length: 84

Response

Live exposure, or status: "starting"

success
boolean
Example:

true

data
object