latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

accountManagementAccounts14

accountManagementBanking20

accountManagementReports6

accountManagementUtilities9

authorizationSsoBrowserSessions1

authorizationSsoSessions1

authorizationToken1

preTradeComplianceRestrictions6

thirdPartiesCashBalances1

thirdPartiesTaxVouchers6

tradingAccounts11

tradingAlerts6

tradingContracts16

tradingEventContracts5

tradingFaAllocationManagement18

tradingFyIsAndNotifications11

tradingMarketData4

tradingOAuth10A3

tradingOrders11

tradingPortfolio13

tradingPortfolioAnalyst4

tradingScanner2

tradingSession5

tradingWatchlists4

tradingWebsocket1

utilitiesEcho2

preTradeComplianceRestrictions

Get Restriction IDs For A User

Returns all restriction IDs for the given username. The username must be the master user, a sub-user, or a user with trading access under the master account. Returns 403 for both unauthorized and non-existent users to prevent ID enumeration.<br><br>Scope: restrictions.read<br>Security Policy: HTTPS

get/gw/api/v1/restrictions/user

Query parameters

masterUserNamestring required

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

userNamestring required

Username to query. Max 64 characters.

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

Restriction IDs for the user.

statusstring required

Always ok on success.

userNamestring required

Echoed from the request. If the supplied userName was an alias, the alias is returned as-is.

restrictionIdsinteger[] required

Restriction IDs for the user. Empty array when none.