Skip to main content
PUT
TypeScript

Authorizations

Authorization
string
header
required

A partner-scoped API key (trdrs_sk_…), issued to a trdrs Connect partner firm and accepted only under /api/partner/. Same format as the firm (tenant) key, different scope: a firm API key is refused here, and this key is refused everywhere else.

Body

application/json

PartnerRiskSetRequest. Replaces the account’s five controls in one write. An enabled control must carry a positive value; a disabled control’s value is ignored and stored as null.

accountNumber
string
required

A firm-issued account number.

dailyLossEnabled
boolean
dailyLossValue
number
weeklyLossEnabled
boolean
weeklyLossValue
number
dailyProfitEnabled
boolean
dailyProfitValue
number
weeklyProfitEnabled
boolean
weeklyProfitValue
number
eodCloseEnabled
boolean
eodCloseValue
number

Whole minutes before the 16:00 CT close, 1–240.

Response

The controls as stored + current lock state (PartnerRiskStateResponse)

PartnerRiskStateResponse. The account’s risk controls plus whether trading is currently blocked, and by what.

accountNumber
string
required
settings
object
required

PartnerRiskSettings. The five per-account controls, each a toggle plus a threshold. Loss/profit values are in account currency and positive; a disabled control’s value is null. eodCloseValue is minutes before the 16:00 CT session close, 1–240.

Example:
halted
boolean
required

True when trading on the account is currently blocked — by your halt, a risk trigger, or an evaluation breach.

lockReason
string | null
required

Why trading is blocked: firm_halt (yours), daily_loss, weekly_loss, daily_profit, weekly_profit, eod_close, or eval_breach. Null when trading.