WebSocket

Connecting

Establish a WebSocket connection and authenticate with the API.

Endpoints

Choose the region closest to your deployment, then choose the endpoint family that matches your channels.

Endpoint familyUse forSingaporeEurope
bookBLOCK_BOOK_SNAPSHOTwss://ap-sin3.ws.api.kiyotaka.ai/wswss://eu-de3.ws.api.kiyotaka.ai/ws
nonbookAll other channelswss://ap-sin3.ws.api.kiyotaka.ai/nonbook/wswss://eu-de3.ws.api.kiyotaka.ai/nonbook/ws

If you need both orderbook and non-orderbook feeds, open one connection to each endpoint family. For public API integrations, append ?encoding=json to the endpoint you use and send JSON messages:

Endpoints
wss://ap-sin3.ws.api.kiyotaka.ai/ws?encoding=json
wss://ap-sin3.ws.api.kiyotaka.ai/nonbook/ws?encoding=json

Authentication

Authenticate immediately after connecting by sending your API key:

JSON
{
  "method": "public/authenticate",
  "params": {
    "token": "YOUR_API_KEY"
  }
}

You must authenticate before subscribing to any channels.