Account

Accounts track positions and apply the pre-trade checks configured for their account type and account group. When a new trade request is received, the system will check the relevant settings on Account and AccountGroup to identify if the execution of this trade would surpass any configured limits. If any such limits are exceeded, the trade request will be flagged, and the system will take relevant actions based on the account type. Account has the following attributes and can be accessed via pending config or real-time config:

attributes	required	default settings	attribute type	description
id	Y	–	INT	The ID of the Account.
name	Y	–	STRING	The name of the Account. The Account is known throughout the system via its name.
description	N	n/a	STRING	Free text for the description of the Account.
group	Y	–	STRING	The AccountGroup to which the Account is linked.
exp_limit	N	-1	DOUBLE	Unleveraged exposure limit for the account, expressed in the account group’s default currency (`DEFAULT_CCY`). • If exp_limit is set to -1, this account-wide cap is disabled. Margin, symbol and currency limits still apply independently. • If exp_limit is >= 0, only orders which will result in exposure reduction or exposure <= exp_limit will be allowed for execution. On RISK accounts the cap can reduce the portion retained as B-book and route the remainder to A-book as overflow, instead of rejecting the whole order. • POSITION accounts must keep -1.
stopout_level	N	-1	DOUBLE	Automatic stopout becomes eligible when margin utilization reaches or exceeds this percentage (`100` means 100%). Set `-1` to disable automatic stopout. `0` is an active threshold. A value other than `-1` is allowed only on MARGIN accounts. Account requirements • The account is enabled and has type `MARGIN`. • Its AccountGroup has `EXPOSURE` set to `BALANCE` or `EQUITY`. Liquidation settings in AccountGroup • `STOPOUT_MODE`: `all` submits closing orders for all open positions; `pnl` selects positions by P/L and projected remaining margin utilization. • `STOPOUT_EQUITY`: `any` allows either equity sign; `negative` requires equity strictly below zero.
connector_account	N	n/a	STRING	The connector account used for stopout orders. Format: `connector_name\|connector_account_name`. Account with no child accounts (leaf account): When stopout is enabled, select an existing connector account whose `margin` field points to this account. Closing orders use that connector account’s symbol execution settings. Parent account: When stopout is enabled, use `n/a`. Closing orders are sent for each account with no children beneath it, through that account’s own `connector_account`, which must be set even if that account’s own stopout is disabled.
parent	N	n/a	STRING	Represents the name of a parent account. If an Account is linked to a parent account, trade positions on the child account are also reflected on the parent account, and the parent’s limits apply to trades on its child accounts. The parent’s margin check uses the parent’s own balance, not the balances of its child accounts. A RISK account can only be linked to a RISK parent. POSITION accounts cannot have a parent. An account that has child accounts must not be used as the `margin` or `risk` account of a ConnectorAccount.
enable	N	n/a	TINYINT	Specifies if the Account is enabled or disabled. A disabled account used as the `margin` account of a ConnectorAccount rejects new trades on that connector account. Disabling a parent account does not reliably stop trading on its child accounts; disable the child accounts themselves. •Note: For a RISK-type Account linked via a ConnectorAccount's `risk` field, disabling it is not supported. The Portal rejects disabling RISK accounts.

Automatic stopout

For a positive balance or equity, margin utilization is margin / balance × 100 when EXPOSURE=BALANCE, or margin / equity × 100 when EXPOSURE=EQUITY, capped at 100,000%. Zero margin gives utilization of 0%. If margin is positive but the balance or equity used in the calculation is zero or negative, utilization is 100,000%.

Closing orders use the configured stopout route and its symbol execution settings. Their submission does not guarantee a fill or immediate liquidation of the account.

Account Types

NOP

For NOP accounts, positions that have reached their value date are excluded from the applicable exposure and P&L calculations.

Margin

MARGIN accounts do not apply this value-date exclusion.

RISK

Risk Accounts keep track of B-book trades and route trades to liquidity providers if any configured limits are exceeded. Positions of such trades will be tracked in the AccountPosition component and recorded as “overflow”.

Warning: A Risk Account linked to a ConnectorAccount must stay enabled.

POSITION

Use position accounts together with ProviderTrade to monitor provider-side positions and trading activity. This account type is informational only and imposes no trading limitations.