Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

Your firm’s API key (the API calls this the tenant key; trdrs_sk_…), server-to-server only.

Query Parameters

broker
string
required

A connected broker (rithmic, tastytrade, paper, ...). Required: risk controls are per account, never a priority default.

account
string

Pick an account within that broker. Validated against the caller's own set; out-of-set is a 400.

Response

The controls as stored and the current lock state

RiskStateResponse. The account controls as stored, and the current lock state.

settings
object
required

RiskSettings. The five per-account controls: four loss/profit thresholds in account currency and the end-of-day close in whole minutes before the 16:00 CT session close. An enabled control always carries a positive value; a disabled one reads null.

lock
object
required

RiskLock. The lock and monitoring state the risk monitor holds for one account. tradingLocked is the fail-closed gate every order-placing route reads (423 risk_locked while true); settingsLocked refuses control edits and the manual unlock until settingsUnlockAt.