Skip to main content
POST
Create a personal API key session

Body

application/json

Request body for a personal API key session.

api_key
string
required

The trader's personal API key ("hpp_..."), created in Settings → API keys.

email
string | null

Optional. The trader's Hyperprop login email; when sent it must match the key's owner (case-insensitive).

firm
string | null

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

access_token
string
required

Bearer token for subsequent requests, limited to account_ids.

account_ids
string<uuid>[]
required

Trader accounts this session can see and trade.

expires_in
integer<int64>
required

Seconds until the token expires; exchange the key again to refresh.

Required range: x >= 0
markets
string[]
required

Markets the session can trade: crypto and futures. Market data isn't included.

organizations
object[]
required

Every firm the session reaches, with the trader's accounts at each.

scope
string
required

trade (reads and orders) or read (reads only).

session_type
string
required

Always personal_api_key.

token_type
string
required
organization_id
string<uuid> | null

Set when every account in the session belongs to one firm.

organization_name
string | null
organization_slug
string | null