Session

Authentication Status

Current Authentication status to the Brokerage system. Market Data and Trading is not possible if not authenticated, e.g. authenticated shows false

post/iserver/auth/status

Request

Base URL
http://localhost:5000/v1/api
Auth
none declared
TypeScript
https://skmtc.dev/ibkr/apis/client-portal-web-api/docs/iserver/auth/status/post.ts
A function with typed inputs. Its response is checked against the schema.

authenticatedboolean

Brokerage session is authenticated

connectedboolean

Connected to backend

competingboolean

Brokerage session is competing, e.g. user is logged in to IBKR Mobile, WebTrader, TWS or other trading platforms.

failstring

Authentication failed, why.

messagestring

System messages that may affect trading

promptsstring[]

Prompt messages that may affect trading or the account

No recorded changes to this operation across all 1 revision of this API.