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

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.

Response

The open positions. qty is positive for long and negative for short. liquidationPrice, leverage and margin are null where there is no such thing, such as leverage for futures.

The open positions, and the position mode they were read under, in one read.

positionModel
enum<string>
required

How the account holds positions. net means at most one signed row per instrument. independent_tickets is a paper book account where each entry order opens its own ticket, so every open ticket is its own row with its own positionId, and opposite tickets on one instrument are two rows, never one net row.

Available options:
net,
independent_tickets
positions
object[]
required

The open positions.