Forex | Connect WebSocket API

Forex.com / StoneX / CityIndex streams market data and account updates through Lightstreamer. The component speaks the native Lightstreamer TLCP 2.5 wire protocol over a WebSocket; no Lightstreamer native library is required.

Transport

• WebSocket subprotocol: TLCP-2.5.0.lightstreamer.com. Advertised in the Sec-WebSocket-Protocol request header.
• Adapter set: STREAMINGALL. Configured on the internal Lightstreamer subprotocol client; all Forex.com data adapters (PRICES, ORDERS, QUOTES, CLIENTACCOUNTMARGIN, TRADEMARGIN) live under this adapter set.
• CID: mgQkwtwdysogQz2BJ4Ji kOj2Bg. The Lightstreamer TLCP 2.5 specification designates this value as the generic-client identifier for non-proprietary clients; see TLCP 2.5 specification.
• Authentication: the session token obtained from the REST LogOn call is sent as LS_password when creating the Lightstreamer session, together with LS_user set to the account user name.

Reconnection

When AutoReconnect is enabled (the default) the underlying WebSocket client WatchDog reopens the socket after network errors. The Lightstreamer protocol itself signals LOOP frames when the server wants the client to move to a different URL or rebind the session; the component handles those transparently and only raises OnForexDisconnect / OnForexConnect around full session breaks.

When the REST session expires (no Ping for a long time) the streaming server closes the session. The component calls LogOn again using the stored credentials, refreshes SessionToken, and restarts the Lightstreamer session with the new token.

Sample

Open the streaming session

oForex := TsgcWSAPI_Forex.Create(nil);
oForex.Credentials.UserName := '<username>';
oForex.Credentials.Password := '<password>';
oForex.Credentials.AppKey  := '<appkey>';
oForex.OnForexConnect    := ForexConnected;
oForex.OnForexDisconnect := ForexDisconnected;
oForex.OnForexException  := ForexException;
oForex.AutoReconnect     := True;
oForex.Connect;
// ... application ...
oForex.Disconnect;