Overview
This channel streams realtime account-related data: orders, buying power, and portfolio — over Socket.IO. It is a separate channel from Priceboard (see Connecting to Priceboard) and requires a valid access token.There are two distinct paths depending on product type — use the one matching the account you’re working with:
- Stocks / underlying securities:
eqt - Derivatives:
fno
Connection details
Prerequisites
Before connecting, you need:access_token— obtained from the login API (auth/gen-secret-key/underlying). It must still be valid at the time you subscribe.sub_account_id(trading sub-account) — NOT your login username / custody code (e.g.022Cxxxxxx). This is the actual trading sub-account number, formatted like0301001425. Using the wrong value here causesFO20010 - Invalid sub-accounterrors elsewhere in the API, and prevents the realtime subscription from returning the correct account data.
Connection steps
1
Log in to get an access_token
Call the auth API to obtain a valid token for the session.
2
Initialize the client
Connect to the matching host + path (
eqt or fno), forcing the websocket transport.3
Send the subscribe payload
After
connect, emit a get event with a payload containing your sub_account_id and access_token.4
Listen per channel
The server pushes data through separate events by business type — see the mapping table below.
Example code (Node.js / JavaScript — Underlying/EQT)
Channel mapping
Some older gateways may emit
instrument, trade, account instead of OM/CI/SE. If you’re unsure which gateway version you’re on, register listeners for both naming sets for backward compatibility.Response structure
Account data arrives wrapped in a common envelope. TheEVENTTYPE field inside DT — not the outer Socket.IO event name — is what actually tells you whether this is OM, CI, or SE.
Real example — a CI (Cash Info / buying power) event:
Common envelope (applies to every EVENTTYPE)
CI (Cash Info — Buying Power) fields
The
DT field structure for OM (Order Management) and SE (Securities Equity) differs from CI and will be added once a corresponding real sample is available.