API ReferenceTradingTrading Session

Brokerage Session Status

View as MarkdownOpen in Claude
Current Authentication status to the Brokerage system. Market Data and Trading is not possible if not authenticated.

Response

Detailed status of the Brokerage session
authenticatedbooleanOptional
Returns whether your brokerage session is authenticated or not.
establishedbooleanOptional
Returns whether your brokerage session is fully established and ready to handle requests. Set to true when the login message is received from underlying brokerage infrastructure, indicating authentication is complete and account information is loaded.
competingbooleanOptional
Returns whether you have a competing brokerage session in another connection.
connectedbooleanOptional
Returns whether you are connected to the gateway or not.
messagestringOptional
A message about your authenticate status if any.
MACstringOptional
Device MAC information.
serverInfoobjectOptional
hardware_infostringOptional
Client Portal use only.
failstringOptional
Returns the reason for failing to retrieve authentication status.

Errors

401
Unauthorized Error