Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

The Trading API key (trdrs_sk_…), for market data, orders and account state on the accounts its owner holds. Use it server-to-server only, never in a browser. Its scope is named tenant in the API.

Query Parameters

broker
string

The provider the account is at, such as rithmic or paper. Omit it to use your default provider. An unknown value is refused with 400, never replaced with another provider.

account
string

The account number at that provider. It must be one of your own accounts, or the call is refused with 400.

instrument
string

The instrument to check. Omit it for the verdicts across the whole account.

Response

One verdict per action. The checks run in this order: whether live trading is switched on (feature_disabled), the account's holds (risk_locked), the asset classes the provider may trade, an issued account's venue conditions, the account's settings at its provider, and the paper book's product rules. Anything that depends on the order itself or the moment, such as its size, a venue limit or whether the price is fresh, is checked only when you send the order, and a cancel is never refused by a standing rule. An account bound to a risk policy that is held only because an instrument it holds has had no price yet shows that hold here (risk_locked, with risk_uncovered). When you send an order, one that adds to that instrument is refused as market_data_unavailable, and one that adds to any other instrument as risk_locked.

What the account may do right now, as one verdict per action. Each verdict is the answer the route that carries the action would give. Without an instrument, open, reduce, close and protect say what stops them on every instrument, and flatten says what stops flattening the whole account. On the paper book, flattening the account closes every position it can, and each position's own verdict says which one it can't. A feature the provider doesn't support at all is stated in the account's capabilities, not here.

instrument
string | null
required

The instrument the verdicts are for, as you requested it, or null for the account-wide verdicts.

actions
object
required

One verdict per action. Live trading can be switched off, and then every order through POST /api/trading/order is refused, so open and reduce both follow that switch. A risk hold (risk_locked) or a reconciliation hold (reconciliation_hold) refuses an entry. A reduce-only order passes both holds where the provider enforces reduce-only, so reduce follows the holds only where it doesn't. On an account a venue issued, the venue lets a reduction through every entry check. The close route is not stopped by the switch. Under a hold, a close passes only where the provider enforces it as reduce-only, so close follows the hold elsewhere, while flatten and cancel stay available.

checkedAt
integer
required

When the verdicts were worked out, in epoch seconds.