This is a supported, server-to-server integration path. It is separate from
the organization API key flow, which is for prop firms
operating their own accounts from their own backend.
How it differs from an organization key
If you are a prop firm provisioning and managing accounts, you want the
Platform API and an org key — start at the Quickstart. If you
are building a tool a trader connects their own account to, read on.
Prerequisites
Partner applications are issued credentials by Hyperprop — anapp_id and an
app_secret. These are not self-service: contact Hyperprop to have your
application reviewed and registered.
The flow
1
The trader generates a key
In the Hyperprop app, the trader creates an API key for your integration.
The key looks like
hpk_... and is theirs — they can list or revoke it at
any time. The full key is shown once, at creation; if it is lost, the
trader revokes it and creates a new one.2
The trader gives you the key and their email
The key identifies the trader. Collect the email address they sign in to
Hyperprop with as well; it is checked against the key’s owner so a
mistyped or swapped key fails early.
3
You exchange them for a session token
Call
POST /trade/partner/session with your app credentials, the trader’s
key and email. You get back a short-lived bearer token covering the
trader’s accounts. Optionally, name a firm to limit the session to it.4
You use that token as a normal Trade API bearer token
Orders, positions, brackets, WebSocket streaming — the whole Trade API,
limited to the accounts the session returned.
Exchanging credentials for a session
organizations lists every firm the session reaches, with the trader’s
accounts at each. organization_id, organization_name, and
organization_slug are set when all of the session’s accounts belong to one
firm, and are null when it spans several.
Then call the Trade API with it:
Limiting a session to one firm
Withoutfirm, the session covers the trader’s accounts at every firm they
trade with.
When you send firm, the session token acknowledges only the trader’s
accounts at that firm. Accounts the same trader holds at other firms are
invisible to that session — for reads, for writes, and for WebSocket events
alike. They are not filtered out of the UI; they are not addressable. To act
at a second firm this way, run the exchange again with a different firm and
keep the tokens separate.
Token lifetime
Sessions are short-lived — treatexpires_in (seconds) as authoritative
rather than hardcoding a number. There is no refresh token: when a session
expires, repeat the exchange with the stored trader key. Store the trader’s
hpk_... key, not the session token.
Revocation
A trader can revoke their key at any time from the Hyperprop app.- New session exchanges with a revoked key fail immediately.
- Sessions already minted from it keep working until the token expires.
401 on the exchange as
“disconnected, ask the trader to reconnect”, not as a retryable error.
Partner sessions cannot mint keys. Key creation requires the trader’s own
Hyperprop session, which keeps your integration out of the business of
issuing credentials on a trader’s behalf.
Brackets when adding to a position
Take-profit and stop-loss brackets belong to the position. When an order adds to an open position, its TP/SL either merges into the position’s bracket (which resizes to cover the added contracts and keeps its own prices) or becomes a separate exit leg. The optionalbracket_intent field on the order
request controls this:
To keep separate exits per entry, send absolute prices with
"bracket_intent": "ladder". An order that opens a new position, or carries no
TP/SL, is not affected.
Rate limits and errors
The Trade API applies per-account rate limits. A partner session shares the account’s order submission and modification buckets with the trader and any other app. Exits (cancels, closes, flattens) are counted separately: your app has its own exit allowance on each account, so it can’t use up the trader’s ability to close from the terminal, and the trader can’t use up yours. On top of the per-account limits:
Requests from one address are also limited across every API; exits have their
own, higher allowance there too. See Rate limits for
every number and the 429 format.
Errors use the standard envelope with a machine-readable
code — switch on
code, never on message text. The full list is in the Trade API reference
tab.
Browser access
Run the session exchange from your backend. Trade API browser calls are restricted to approved origins — that restriction applies to browsers only and never to server-to-server calls, which send noOrigin header. If your
product needs a browser to talk to the Trade API directly, contact us to get
your origin approved; it is a configuration change on our side.