latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

preTradeComplianceRestrictions

Get List Details

Returns list metadata and instrument entries. The list must be owned by the caller. Returns 403 for both unauthorized and non-existent lists to prevent ID enumeration.<br><br>Scope: restrictions.read<br>Security Policy: HTTPS

get/gw/api/v1/restrictions/list

Query parameters

masterUserNamestring required

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

listIdinteger required

Positive integer in the range 1–2147483647. Decimals and non-numeric values return 400. Values above 2147483647 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

List metadata and entries.

statusstring required

Always ok on success.

listIdinteger required

Range 1–2147483647.

typestring

Example values: SYMBOL, CONID, EXCHANGE, SECTOR, ISSUERORCONID.

namestring

List name.

descriptionstring nullable

List description.