Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

preTradeComplianceRestrictions

Get Restriction Details

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.<br><br>Scope: restrictions.read<br>Security Policy: HTTPS

get/gw/api/v1/restrictions/restriction

Query parameters

masterUserNamestring required

IBKR master username of the authenticated caller. Max 64 characters.

restrictionIdinteger required

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

isEmpTrackstring

Set to T for employer-track authorization.

Headers

Authorizationstring required

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.

Response

Full restriction details.

statusstring required

Always ok on success.

restrictionIdinteger required

Echoed from the request.

namestring

Restriction name.

descriptionstring nullable

Restriction description.

messagestring nullable

Shown to users when the restriction triggers.

applicationTypestring

Example values: Restrict.

usageTypestring

Example values: Trading, Compliance, Monitor.

allowOnlystring nullable

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

matchAllstring nullable

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.

tmFirstDateinteger

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