Create a partner session
Exchanges partner app credentials + a trader API key for a short-lived
bearer token. The key identifies the trader; an optional email must match
its owner. With firm, the token only acknowledges the trader’s accounts at
that firm: accounts at other firms are invisible to the session, for reads,
writes and WebSocket events alike. Without firm, the session covers the
trader’s accounts at every firm.
Body
Request body for the partner session exchange.
Raw trader API key ("hpk_..."). Identifies the trader.
Partner application id issued by Hyperprop.
Raw partner application secret.
Optional. The trader's Hyperprop login email; when sent it must match the key's owner (case-insensitive).
Optional. Limits the session to one firm: organization id, slug or name. When omitted, the session covers all of the trader's firms.
Response
Session created
Bearer token for subsequent requests, limited to account_ids.
Trader accounts this session can see and trade.
Seconds until the token expires; re-login to refresh.
x >= 0Every firm the session reaches, with the trader's accounts at each.
Set when every account in the session belongs to one firm; null when the session spans several firms.