Skip to main content
POST
Create a partner session

Body

application/json

Request body for the partner session exchange.

api_key
string
required

Raw trader API key ("hpk_..."). Identifies the trader.

app_id
string<uuid>
required

Partner application id issued by Hyperprop.

app_secret
string
required

Raw partner application secret.

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; re-login to refresh.

Required range: x >= 0
organizations
object[]
required

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

token_type
string
required
organization_id
string<uuid> | null

Set when every account in the session belongs to one firm; null when the session spans several firms.

organization_name
string | null
organization_slug
string | null