Skip to main content
GET
List trading accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id
string<uuid>

Organization to list. A user or API key may only name its own; a service token may name any.

account_id
string<uuid>

Narrows the listing to one trading account. An account the caller cannot see matches nothing and returns an empty page.

require_credentials
boolean

When true, include only accounts with an enabled credential

enabled
boolean

Filter by enabled state

include_deleted
boolean

When true, list deleted accounts alongside live ones. Used only for service tokens; ignored for users and API keys.

cursor
string

Cursor from the previous page

Response

Accounts retrieved

data
object[]
required
next_cursor
string | null
simulations
object | null

The simulator timings for the accounts in data, keyed by account id.

Present only when the listing was asked for test_accounts=true, and absent entirely otherwise: a real account has no simulator to configure.

Carried beside data rather than folded into it because data is TradingAccount, and a real account has nowhere to put these. Adding them there would mean a field that is meaningless for almost every row the endpoint ever returns, which is the shape that invites a caller to read it without checking.

Additive and optional, so every existing consumer of this response deserializes it unchanged.