Skip to main content
POST
Generate Subtrader-Bound API Key

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer <admin_user_id>:<access_token> on each request.

Body

application/json
name
string
required

Name identifying the key's purpose, e.g. the institution it is issued to.

fcm_subtrader_id
string
required

The subtrader to bind, spelled {your_account_id}_{suffix} with a suffix of 1-16 characters of [a-z0-9]. Must already exist and belong to you.

Response

API key generated

api_key_id
string
required
private_key
string
required

RSA private key in PEM format. Returned exactly once and never stored; it cannot be retrieved again.

warning
string | null

Present only when the bound subtrader is missing a per-subtrader risk control - the initial-margin cap (margin lane) or the event-contract daily cap. The mint still succeeds; the warning names each missing control - an event-contract subtrader without a daily cap has its event-contract orders rejected until one is set, while a margin subtrader without an initial-margin cap is bounded only by firm-level risk limits.