For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
The /api/v1/sso-browser-sessions endpoint can be used to create Single Sign On (SSO) session to seamlessly connect user to the IBKR Client Portal. The IBKR Client Portal is a browser based interface where users can view portfolio information, manage account settings, manage orders, initiate funding, and access account statements. The portal will reflect hosting firms branding (logo, company name, color theme) IF white branding is configured. Parameters for target page are case and space sensitive.
Workflow
Hosting firm will call the /api/v1/sso-browser-sessions and provide credential and ip of the end user.
credential: IBKR username associated with the user.
ip: Static IP is required and must be the actual customer’s computer (their IP-REMOTE_ADDR).
Example
POST /api/v1/sso-browser-sessions { "ip": "206.106.137.230", "credential": "potest123"}
IBKR returns a response URL with SID (unique token). Hosting firm invokes the URL with SID token into the users browser, new window opens and the user lands in IBKR White Branded Portal.
SID is only valid for 60 seconds and can only be accessed from the IP which was included in the original request.
Error will be triggered IF unique SID is accessed more than once, entered after 60 seconds, OR if IP which SID is accessed from is different from IP that was passed in the original request to create single sign on session.
SSO is only supported for browsers (Desktop or Mobile Browser). SSO is not supported for natively installed mobile applications.
When an account is initially created, IBKR will assign a temporary password to the account. One time setup where the user is required to reset the temporary password after the account has been created.
Authentication using the IBKR credential (username) and password is required when adding withdrawal instructions and initiating withdrawal requests using the IBKR hosted portal.
Set Target Page
By default, when you create an SSO session for an opened account, your users will land on the Client Portal home page. However, you can direct users to a specific target page by adding the ACTION parameter to your start call.
If you set a target page, the IBKR navigation panel will be displayed by default, allowing users to access other features within the Portal beyond just the target page.
For a more streamlined experience, we offer an “IFRAME” option that removes the IBKR navigation panel. To create IFRAME, simply include showNavBar=false in your SSO URL.
Optional- If not set OR invalid, user is directed to the Client Portal home page.
showNavBar
true false
Optional- If missing OR set to true, user will land on Client Portal home page. If set to false, navigation bar will not be displayed and this will create ‘IFRAME’. showNavBar=false is only supported for select features. IF set for unsupported feature, user will land on Client Portal home page.
Common Target Pages
Landing Page
ACTION
IFRAME Supported?
Account Settings
ACTION=AccountSettings&SID=<>
Y
Auto Select Account (for Linked Accounts)
If the autoSelect parameter is passed with an account ID, portal will select that account on the landing page (if the account is available for selection). Example where U1234 = Account ID ACTION=autoSelect=U1234&noPickerClear=T Example if using auto select for Funding: ACTION=TransferFunds&autoSelect=U1234&noPickerClear=T
Funding: ACTION=TransactionHistory&SID=<> All Transactions: ACTION=RpTransactionHistory&SID=<>
Y
Transfer Funds
ACTION=TransferFunds&SID=<> The following parameters can be set IF ACTION=TransferFundstype: DEPOSIT or WITHDRAWAL method: ACH, BPAY_NOTIFICATION, BILL_PAY_NOTIFICATION, CHECK_NOTIFICATION, DIRECT_DEPOSIT, EDDA, EFT, LVP, OPEN_BANKING, WIRE, WISE_BALANCE, WISE_BANK_NOTIFICATION,, WISE_OUTBOUND, currency: USD, CAD, HKD, CNH, EUR, GBP, AUD A few examples below:Deposit (Display all saved instructions): ACTION=TransferFunds&type=DEPOSIT¤cy=USD&SID=<> ACH Deposit: ACTION=TransferFunds&method=ACH&type=DEPOSIT¤cy=USD&SID=<> EFT Deposit: ACTION=TransferFunds&method=EFT&type=DEPOSIT¤cy=CAD&SID=<> Open BankingPlaid Europe: ACTION=TransferFunds&type=DEPOSIT&method=OPEN_BANKING¤cy=<GBPorEUR> Wire Deposit: ACTION=TransferFunds&method=WIRE_NOTIFICATION&type=DEPOSIT¤cy=XXXWise Balance: ACTION=TransferFunds&method=WISE_BALANCE&type=DEPOSIT¤cy=XXX Wise Deposit: ACTION=TransferFunds&method=WISE_BANK_NOTIFICATION&type=DEPOSIT¤cy=XXXWithdrawal (Display all saved instructions): ACTION=TransferFunds&type=WITHDRAWAL¤cy=USD&SID=<> ACH Withdrawal: ACTION=TransferFunds&method=ACH&type=WITHDRAWAL¤cy=XXXEFT Withdrawal: ACTION=TransferFunds&method=EFT&type=WITHDRAWAL¤cy=CAD&SID=<> Local Bank Transfer: ACTION=TransferFunds&method=LVP&type=WITHDRAWAL¤cy=XXXSEPA Withdrawal: ACTION=TransferFunds&method=SEPA&type=WITHDRAWAL¤cy=XXXWire Withdrawal: ACTION=TransferFunds&method=WIRE&type=WITHDRAWAL¤cy=XXXWise Withdrawal: ACTION=TransferFunds&method=WISE_OUTBOUND&type=WITHDRAWAL¤cy=XXX
Y
Transfer Positions
ACTION=TransferPositions&SID=<> The following parameters can be set IF ACTION=TransferPositionstype: POSITION_INBOUND, POSITION_OUTBOUND, INTERNAL method: ACATS, ATON, FOP, DRS, DWAC, ASSET_TRANSFER A few examples below:Incoming ACATS Transfer: ACTION=TransferPositions&type=POSITION_INBOUND&method=ACATS&SID=<> Incoming US FOP: ACTION=TransferPositions&type=POSITION_INBOUND&method=FOP&SID=<> Internal Transfer: ACTION=INTERNAL&SID=<> Outgoing Basic Non-US FOP: ACTION=TransferPositions&type=POSITION_OUTBOUND&method=ASSET_TRANSFER&SID=<>
Requires a minimum of 1200px width. If smaller then we only provide side-car order ticket which doesn’t open on a new page. Meaning, this can only be used when connecting from desktop browser, not mobile.
