API ReferencePre Trade Compliance Restrictions

Get List Details

View as MarkdownOpen in Claude

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.

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.
listIdlongRequired1-2147483647

Positive integer in the range 1–2147483647. Decimals and non-numeric values return 400. Values above 2147483647 return 400.

isEmpTrackstringOptional

Set to T for employer-track authorization.

Response

List metadata and entries.
statusstring

Always ok on success.

listIdlong1-2147483647

Range 1–2147483647.

entrieslist of objects
Instrument entries. Empty array when none.
typestring

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

namestring
List name.
descriptionstring or null
List description.

Errors

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