How it differs from the other credentials
Building an app that other traders connect to? Use a
partner integration instead.
Quickstart
1
Create a key
In Settings → API keys → Personal Keys, choose Create Key, give it
a label and choose its access. Copy the key: it looks like
hpp_... and is
shown only once.2
Exchange the key for a session token
3
Use the token as a Trade API bearer token
Keys and access
Each key has one of two access levels, chosen when you create it:- You can have up to 5 active personal keys.
- Revoking a key in Settings → API keys stops new sessions at once, and sessions already opened with it end within 30 seconds.
- Personal keys and partner keys are separate. A personal key never works with
partner app credentials, and a partner key never works on
/trade/api-keys/session.
The session
POST /trade/api-keys/session takes:
The response:
- The token lasts 15 minutes. Exchange the key again for a fresh one.
account_idslists the accounts the session can reach: all of yours (at one firm, when you sentfirm).scopeistradefor a Read and write key andreadfor a Read only key.- Every response to a personal key session carries the header
x-hyperprop-session: personal-api-key.
What a personal key session can do
Your trading records are always included: order, stop and fill prices,
realized P&L, fees, balances and history. Live values based on futures prices
are not:
- A futures position has
mark_price,marked_atandunrealized_pnlset tonull, and"market_data_withheld": true. Crypto positions keep them. - While an account has an open futures position, its
equity,unrealized_pnl,current_drawdownanddrawdown_from_hwmarenull, and the account has"market_data_withheld": true. The same applies to its account updates on the trade event stream.
GET /trade/perp/mark serves perpetuals only and returns 403 for a
futures symbol.
A route that personal keys can’t use returns 403 with code
PERSONAL_KEY_FORBIDDEN.
Reading your journal
The journal endpoints on the Platform API accept a personal key too:GET /platform/v1/user/trading/trades and
GET /platform/v1/user/trading/orders. Send the key on its own, or send the
session token:
Using your key with an AI assistant
Connect Claude, ChatGPT, Cursor or your own agent with your personal key to let it read your accounts and journal or, with a Read and write key, place orders after you approve them. See MCP connector.Limits and errors
Order submissions and modifications follow the same per-account limits as
every other session. Exits (cancels, closes, flattens) have their own
allowance for your personal keys, so a script or agent that uses it up can’t
stop you closing from the terminal. See Rate limits
for every number.