API ReferenceTrading 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
authenticatedboolean
Returns whether your brokerage session is authenticated or not.
establishedboolean
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.
competingboolean
Returns whether you have a competing brokerage session in another connection.
connectedboolean
Returns whether you are connected to the gateway or not.
messagestring
A message about your authenticate status if any.
MACstring
Device MAC information.
serverInfoobject
hardware_infostring
Client Portal use only.
failstring
Returns the reason for failing to retrieve authentication status.

Errors

401
Unauthorized Error