Forex Web Socket API

About Forex Web Socket

A WebSocket is a type of communication protocol that allows for real-time updates, such as forex stock prices and quote data.

Login: { "event": "login", "data": { "apiKey": "your_api_key" } }
Subscribe: { "event": "subscribe", "data": { "ticker": ["eurusd", "cndusd"] } }
Unsubscribe: { "event": "unsubscribe", "data": { "ticker": ["eurusd", "cndusd"] } }

Parameter:
ticker: Subscribe to single ticker by providing as a string, or Subscribe to multiple tickers by providing list of tickers as following example.
data: { "ticker": "eurusd" } or { "ticker": ["eurusd", "cndusd"] }.

Response:
s: Ticker related to the asset.
t: Timestamp
type: Trade type (Communicates what type of price update this is. Will always be 'T' for last trade message, 'Q' for top-of-book update message, and 'B' for trade break messages.)
ap: The current lowest ask price. Only available for Quote updates, null otherwise.
as: The number of shares at the ask price. Only available for Quote updates, null otherwise.
bs: The number shares at the bid price. Only available for Quote updates, null otherwise.
bp: The current highest bid price. Only available for Quote updates, null otherwise.
lp: The last price the last trade was executed at. Only available for Trade and Break updates, null otherwise.
ls: The amount of shares (volume) traded at the last price. Only available for Trade and Break updates, null otherwise.