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 An Account

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

get/gw/api/v1/restrictions/account

Query parameters

masterUserNamestring required

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

accountIdstring required

Master or sub-account ID. 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 account.

statusstring required

Always ok on success.

accountIdstring required

Echoed from the request.

restrictionIdsinteger[] required

Restriction IDs for the account. Empty array when none.