API ReferencePreTrade CompliancePre Trade Compliance Restrictions

Get Restriction Scope

View as MarkdownOpen in Claude
Returns a restriction's scope (`Active For Family`, `Active Except`, `Active For Some`, or `Inactive`) and the account IDs relevant to that scope. `accountIds` is omitted for `Active For Family` and `Inactive` (implicit: all/no accounts). For `Active For Some`, `accountIds` is capped at a configurable limit (default 10000) with a `truncated` flag indicating whether more accounts exist beyond the cap. For `Active Except`, `accountIds` (the excluded accounts) is always returned in full, uncapped. The restriction must be owned by the caller's master account. Employee-track (`isEmpTrack=T`) callers are not supported.<br><br>**Scope**: `restrictions.read`<br>**Security Policy**: `HTTPS`

Authentication

AuthorizationBearer

RS256-signed JWT access token signed with your registered private key.

Headers

AuthorizationstringRequired

RS256-signed JWT (Bearer format), signed with your registered private key. Must contain an accountId claim identifying the master account. A missing or invalid token returns HTTP 401.

Query parameters

masterUserNamestringRequired<=64 characters
IBKR master username of the authenticated caller. Max 64 characters.
restrictionIdlongRequired>=1

Positive integer. Decimals and non-numeric values return 400.

isEmpTrackstringOptional

Set to T for employer-track authorization.

Response

Restriction scope and relevant account IDs.
statusstring

Always ok on success.

restrictionIdlong
Echoed from the request.
scopestring

The restriction’s scope. One of: Active For Family, Active Except, Active For Some, Inactive.

accountIdslist of strings or nullOptional

Account IDs relevant to the scope. Omitted entirely for Active For Family (all accounts are implicitly in scope) and Inactive (no accounts). For Active For Some, the directly associated accounts, capped at a configurable limit (see truncated). For Active Except, the excluded accounts, always returned in full and never capped.

truncatedboolean or nullOptional

Present only for Active For Some. true if the account list was capped at the configured limit and more accounts exist beyond it; false if the full list was returned. Never present for other scopes (Active Except is always returned in full, uncapped).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error