Skip to content
APIs
/
CeFi
/
/
TrueX WebSocket API

TrueX WebSocket API 1.0.0

Overview

This API allows clients to interact with the TrueX trading platform for real time instrument, market data and exchange transactions.

Authentication

Certain API requests must be authenticated using HMAC-SHA256 signature authentication.

Unauthenticated Endpoints

Many endpoints have an unauthenticated version which only requires the user to supply a valid timestamp (within 15secs of server UTC time). These endpoints batch updates and publish on an interval set by the exchange, typically 1 second.

Change Log

VersionDateNotes
v1.0.02025-10-16Initial Release.
Download AsyncAPI description
v1.json
v1.yaml
Overview
E-mail

info@truex.co

Terms of Service

Servers
uat
uat.truex.co
More details
production
prod.truex.co
More details
Channel

/api/v1

name: /api/v1

Messages

Accepts one of the following messages:

Payload

typestring

Action the request is intending to take.

Enum"SUBSCRIBE""SUBSCRIBE_NO_AUTH""UNSUBSCRIBE"
Example: "SUBSCRIBE"
item_namesArray of strings

List of items the request is intending to act upon.

Example: ["BTC-PYUSD"]
channelsArray of strings

List of channels the request is intending to interact with.

Example: ["INSTRUMENT"]
timestampstring

Required field on all requests; a UTC Unix epoch in seconds. Must be with 15 seconds of the servers current time.

Example: "1741894773"
organization_idstring

Exchange designation ID will be UUIDv4. Must be supplied in human readable form. RFC 9562.

Example: "30d17c5b-5d7b-4f06-bdc5-d4b3b12bdd4"
keystring

Exchange supplied API key will be in UUIDv4. Must be supplied in huyman readable form. RFC 9562.

Example: "6398805c-f369-40f6-ac07-94ce683056e4"
signaturestring

The computed HMAC signature.

Example: "gLoCBQaBqjfBx+Z5o113nUUNgWHaliIhQGISguSLVKY="
Payload
{
  "type": "SUBSCRIBE",
  "item_names": [
    "BTC-PYUSD"
  ],
  "channels": [
    "INSTRUMENT"
  ],
  "timestamp": "1741894773",
  "organization_id": "30d17c5b-5d7b-4f06-bdc5-d4b3b12bdd4",
  "key": "6398805c-f369-40f6-ac07-94ce683056e4",
  "signature": "gLoCBQaBqjfBx+Z5o113nUUNgWHaliIhQGISguSLVKY="
}

Send

Send

subscribe

Message sent to server indicating what channels and data the user would like to subscribe to.

Messages

subscription

Receive

Receive

welcome

Message received when connecting to the server and establishing a websocket connection.

Messages

welcome
Receive

confirmation

Message sent from server containing channels and items the user is currently subscribed to.

Messages

confirmation
Receive

instrument

Message sent from server with instrument data.

Messages

instrument
Receive

trade

Message sent from server containing the lasted trade information for a subscribed instrument.

Messages

trade
Receive

ebbo

Message sent from server containing the lasted exchange best bid and offer information for a subscribed instrument.

Messages

ebbo
Receive

depth

Message sent from server containing the lasted market data change for a subscribed instrument.

Messages

depth