API key — organizations (prop firms)
Organization endpoints take an API key in theX-API-Key header, for
programmatic access from your backend — no browser session needed.
- Keys are managed by organization admins in the dashboard (Settings → API key) or with the API key endpoints in the API reference, and can be rotated or revoked at any time.
- The full
hp_live_...key is shown once, when it’s created, and can’t be retrieved later. - An organization can have up to two active keys at a time.
Read-only keys
Create a key with"scope": "read_only" for anything that only needs to
observe state: reporting jobs, dashboards, risk monitors, read-only AI agents.
GET requests and open the
real-time trading stream. Any other request
is refused with 403 and code READ_ONLY_KEY, and nothing changes. A key’s
scope is fixed when it’s created; to change it, create a new key.
IP allowlist
If your servers call from fixed addresses, restrict a key to them withallowedIps: up to 50 IPv4 or IPv6 addresses or CIDR blocks.
- A request from any other address is refused with
403and codeIP_NOT_ALLOWED. The error message shows the address the request came from, which helps when you are not sure which address your servers use. - The allowlist applies to every use of the key: the Platform API, the trading stream token, the event stream and the MCP connector.
- A single address is stored as
/32(IPv4) or/128(IPv6). - Changes apply within 30 seconds. Send
"allowedIps": []to remove the restriction. You can also setallowedIpswhen you create the key.
Rotating a key without downtime
- Create a new key while the old one is still active.
- Deploy the new key to your backend.
- Wait until the old key’s
lastUsedAtonGET /organization/api-keysstops moving. - Delete the old key. It stops working within 30 seconds.
409 and code
KEY_LIMIT_REACHED; delete one first.
Partner session — third-party apps acting for a trader
A third-party application (trade copier, journal, analytics tool) trades on behalf of an individual trader by exchanging its partner app credentials plus a trader-generated key (hpk_...) and the trader’s email for a short-lived
Trade API token:
"firm" — and the trader can revoke their key at any
time. This is a supported integration
path, distinct from an organization key — full walkthrough in
Partner integrations.
Personal API key — your own tools
A trader can use the Trade API from their own scripts and bots with a personal key (hpp_...), created in Settings → API keys. No partner app is
needed. Exchange the key for a short-lived Trade API token: