Skip to main content
GET
Get the caller's own trading firm

Path Parameters

id
string
required

Firm ID, as a decimal string. Must be your own firm; any other ID returns 403.

Response

Firm

updated_at
integer<int64>
required

Time of the firm's last update, in nanoseconds since the Unix epoch.

Example:

1795651300123456800

id
string

Firm id, as a canonical decimal string.

Example:

"298471892342"

name
string

Firm name.

Example:

"Northwind Trading"

code
string

Three-character firm code.

Example:

"NWT"

fcm_id
string

Id of the firm's parent FCM, as a canonical decimal string.

Example:

"198471892341"

status
string

Firm status, for example ACTIVE or DISABLED.

Example:

"ACTIVE"

participant_type
string

Participant type: HOUSE or CUSTOMER.

Example:

"HOUSE"

aggregation_mode
string

How the firm's positions count toward position limits: NET nets all sub-accounts together, GROSS measures each sub-account separately.

Example:

"NET"

max_order_size
string

Maximum quantity per order in contracts, as a decimal string, or null when no limit is set.

Example:

"5000.00"

self_match_prevention_mode
string

Firm self-match prevention mode: CANCEL_AGGRESSING, CANCEL_RESTING, or CANCEL_BOTH. When set, the firm's orders in the same sub-account do not match each other. Null when unset.

Example:

"CANCEL_RESTING"