Skip to navigation
API ReferencePreTrade CompliancePre Trade Compliance Restrictions

Get Restriction IDs Created By The Caller's Master Account

View as MarkdownOpen in Claude

Returns all restriction IDs created by the authenticated caller’s own master account (or employer, in emp-track mode), same as the PTC portal’s Restrictions page. Each entry includes a byOperator flag distinguishing IB(operator)-created restrictions from Client-created ones.

Scope: restrictions.read
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.
isEmpTrackstringOptional

Set to T for employer-track authorization.

Response

Restrictions created by the caller's master account.
statusstring

Always ok on success.

masterUserNamestring
Echoed from the request.
restrictionslist of objects

Restrictions created by the caller’s master account (or employer, in emp-track mode). Empty array when none.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error