Skip to main content
POST
Generate a trader API key for third-party access

Authorizations

Authorization
string
header
required

A Hyperprop session token, the partner session token returned by POST /trade/partner/session, or the personal API key session token returned by POST /trade/api-keys/session.

Body

application/json
label
string | null

Display label, e.g. "my-journal-app". Shown in key listings only.

Response

Key created

api_key
string
required

The full API key — shown exactly once, in this response. It can never be retrieved again; store it securely now. If it is lost, revoke this key and create a new one.

id
string<uuid>
required

Key id (use for revocation).

key_prefix
string
required

Key prefix, safe to display for identification.

label
string | null