API ReferenceTrading Session

Initialize Brokerage Session

View as MarkdownOpen in Claude

After retrieving the access token and subsequent Live Session Token, customers can initialize their brokerage session with the ssodh/init endpoint.

Request

This endpoint expects an object.
publishbooleanOptional
publish brokerage session token at the same time when brokerage session initialized. If set false, then session token should be published before calling init. Setting true is preferred way.
competebooleanOptional
Determines if other brokerage sessions should be disconnected to prioritize this connection.

Response

An array of objects detailing contract information.
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
500
Internal Server Error
503
Service Unavailable Error