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, and keep it on your server. Its scope is named trading in the API.

Query Parameters

provider
string
required

The provider the account is at, such as rithmic, tastytrade or paper. Required, because a lock belongs to one account and never falls back to a default.

account
string

The account number, when the login holds more than one. It must be one of your own accounts, or the call is refused with 400. Omit it for the login's default account.

Response

Every control off, the lock state now and the account's limits.

The retired risk state: every control off, whether the account is locked now, and, on an account bound to a risk policy, every limit set on it by its venue.

settings
object
required

Every control off.

lock
object
required

Whether the account is locked now.

limits
object | null
required

Every limit on an account bound to a risk policy, read-only. inForce is the version the account is held to now, and next is a version recorded since, which takes effect at the next session day. Null on an account no risk policy binds.