API ReferencePre Trade Compliance Restrictions

Get Restriction Details

View as MarkdownOpen in Claude

Returns full details of a restriction including rules. The restriction must be owned by the caller. Returns 403 for both unauthorized and non-existent restrictions to prevent ID enumeration.

Scope: restrictions.read
Security Policy: HTTPS

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

Full restriction details.
statusstring

Always ok on success.

restrictionIdlong
Echoed from the request.
ruleslist of objects
Rules attached to this restriction. Empty array when none.
namestring
Restriction name.
descriptionstring or null
Restriction description.
messagestring or null
Shown to users when the restriction triggers.
applicationTypestring

Example values: Restrict.

usageTypestring

Example values: Trading, Compliance, Monitor.

allowOnlystring or null

Null when not applicable. The value F returned by the database is normalized to null.

matchAllstring or null

Null when not applicable. The value F returned by the database is normalized to null.

isWhiteListstring
Whitelist flag.
tmFrequencystring

Trade-monitoring recurrence. Present only when configured.

tmFirstDatelong

Trade-monitoring start timestamp in epoch milliseconds. Present only when configured.

Errors

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