API ReferencePre Trade Compliance Restrictions

Get Restriction IDs For An Account

View as MarkdownOpen in Claude

Returns all restriction IDs for the given account. The account must be the caller’s master account or a direct sub-account. Returns 403 for both unauthorized and non-existent accounts 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.
accountIdstringRequired<=64 characters

Master or sub-account ID. Max 64 characters.

isEmpTrackstringOptional

Set to T for employer-track authorization.

Response

Restriction IDs for the account.
statusstring

Always ok on success.

accountIdstring
Echoed from the request.
restrictionIdslist of longs
Restriction IDs for the account. Empty array when none.

Errors

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