Skip to main content
POST
Create a firm-scoped partner session

Body

application/json

Request body for the partner session exchange.

api_key
string
required

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

app_id
string<uuid>
required

Partner application id issued by Hyperprop (e.g. Tradesyncer's app).

app_secret
string
required

Raw partner application secret.

firm
string
required

Firm the session is scoped to: organization id, slug or name.

Response

Session created

access_token
string
required

Bearer token for subsequent requests. Scoped to the firm's accounts.

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
organization_id
string<uuid>
required
organization_name
string
required
organization_slug
string
required
token_type
string
required