Developer Documentation

APIs

CeFi

/apis/cefi/ws/v1

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.

Servers

wss://uat.truex.co/wssuat
TrueX UAT websocket sandbox server.
Security:
HTTP API key
Name: x-no-auth
In: query
Clients may subscribe to endpoints without an API key or computing an HMAC signature. These endpoints are rate limited by the server, coalescing and only sending data at a predetermined rate. Non-authenticated connections can be upgraded by supplying an API key and computed HMAC signature on the the next request sent to the server.

Unauthenticated requests must be have the type: SUBSCRIBE_NO_AUTH and not include the follow fields on the requet: organization_id, key, signature.

Required members

timestamp: A UTC Unix epoch in seconds.

HTTP API key
Name: x-api-key
In: query
Clients must compute and send an HMAC signature in signature member of the request structure. The HMAC signature gets applied to the following payload:

timestamp + TRUEXWS + key + path

Note, path is everything after the domain name including the / (e.g. /api/v1).

Required members

signature: The signature generated from processing the payload with the HMAC key.

key: The ID of the HMAC key being used.

timestamp: A UTC Unix epoch in seconds.
wss://prod.truex.co/wssproduction
TrueX production websocket server.
Security:
HTTP API key
Name: x-no-auth
In: query
Clients may subscribe to endpoints without an API key or computing an HMAC signature. These endpoints are rate limited by the server, coalescing and only sending data at a predetermined rate. Non-authenticated connections can be upgraded by supplying an API key and computed HMAC signature on the the next request sent to the server.

Unauthenticated requests must be have the type: SUBSCRIBE_NO_AUTH and not include the follow fields on the requet: organization_id, key, signature.

Required members

timestamp: A UTC Unix epoch in seconds.

HTTP API key
Name: x-api-key
In: query
Clients must compute and send an HMAC signature in signature member of the request structure. The HMAC signature gets applied to the following payload:

timestamp + TRUEXWS + key + path

Note, path is everything after the domain name including the / (e.g. /api/v1).

Required members

signature: The signature generated from processing the payload with the HMAC key.

key: The ID of the HMAC key being used.

timestamp: A UTC Unix epoch in seconds.

Operations

SEND /api/v1
Message sent to server indicating what channels and data the user would like to subscribe to.

Operation IDsubscribeToChannel
Available only on servers:
- uat
- production
Accepts the following message:
Message IDsubscription
object
type
string
Action the request is intending to take.

Allowed values:
"SUBSCRIBE"
"SUBSCRIBE_NO_AUTH"
"UNSUBSCRIBE"
array<string>
List of items the request is intending to act upon.

Items:
string
array<string>
List of channels the request is intending to interact with.

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

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

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

signature
string
The computed HMAC signature.

Additional properties are allowed.
Examples
{ "type": "SUBSCRIBE", "item_names": [ "BTC-PYUSD" ], "channels": [ "INSTRUMENT" ], "timestamp": "1741894773", "organization_id": "30d17c5b-5d7b-4f06-bdc5-d4b3b12bdd4", "key": "string", "signature": "gLoCBQaBqjfBx+Z5o113nUUNgWHaliIhQGISguSLVKY=" }

This example has been generated automatically.
RECEIVE /api/v1
Message received when connecting to the server and establishing a websocket connection.

Operation IDwelcomeFromServer
Available only on servers:
- uat
- production
Accepts the following message:
Message IDwelcome
object
connections
string
Current number of active connections from the source IP.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
message
string
Message supplied when initiating a connection with the server.

version
string
Current version of the websocket API.

datetime
string
Current datetime of when the server sent the message,

Additional properties are allowed.
Examples
{ "connections": "3", "channel": "WEBSOCKET", "update": "WELCOME", "message": "Welcome to TrueX!", "version": "1.0.0", "datetime": "2025-01-01 17:00:00" }

This example has been generated automatically.
RECEIVE /api/v1
Message sent from server containing channels and items the user is currently subscribed to.

Operation IDconfirmationFromServer
Available only on servers:
- uat
- production
Accepts the following message:
Message IDconfirmation
object
timestamp
string
Server timestamp when the confirmation was generated.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
array<object>
object
channel
string
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "timestamp": "1741894944", "channel": "TRADE", "update": "SNAPSHOT", "status": "AUTHENTICATED", "subscriptions": [ { "channel": "EBBO", "item_names": [ "BTC-PYUSD" ] } ] }

This example has been generated automatically.
RECEIVE /api/v1
Message sent from server with instrument data.

Operation IDinstrumentFromServer
Available only on servers:
- uat
- production
Accepts the following message:
Message IDinstrument
object
seqnum
string
Current sequence number of the channel.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
object
id
string
Exchange assigned ID of the instrument.

status
string
Current instrument state.

Allowed values:
"DISABLED"
"OPENING"
"ACTIVE"
"HALTED"
object
symbol
string
<= 31 characters
Human readable representation of the instrument.

reference_price
string
Price used for initial price limit/band calcuations.

base_asset_id
string
ID of the base asset.

quote_asset_id
string
ID of the quote asset.

price_limit_window_secs
string
Number of seconds in the price limit's sliding window.

price_limit_percent
string
Specifies the percentage threshold for price movement beyond a reference price (e.g., the midpoint or previous close) at which the exchange will take action. If the price of a trade or order breaches this threshold, the exchange may halt trading, trigger a circuit breaker, or initiate other predefined actions to ensure market stability.

price_bands_percent
string
Defines the acceptable price range for order validation within the market. The price bands ensure that orders are priced within a range around the market's midpoint, adjusted for increments and thresholds.

Additional properties are allowed.
object
last_24hr_notional
string
The notional (quantity * price) amount of REFERENCE_ASSET traded over the last 24hr period.

last_24hr_quantity
string
The quantity traded over the last 24 hour period.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "seqnum": "12345", "channel": "INSTRUMENT", "update": "SNAPSHOT", "status": "UNAUTHENTICATED", "data": { "id": "123456789", "status": "ACTIVE", "info": { "symbol": "BTC-PYUSD", "reference_price": "75000.50", "base_asset_id": "123456789", "quote_asset_id": "123456789", "price_limit_window_secs": "3600", "price_limit_percent": "string", "price_bands_percent": "0.025" }, "stats": { "last_24hr_notional": "4325606.30380", "last_24hr_quantity": "123754.2345" } } }

This example has been generated automatically.
RECEIVE /api/v1
Message sent from server containing the lasted trade information for a subscribed instrument.

Operation IDtradeFromServer
Available only on servers:
- uat
- production
Accepts the following message:
Message IDtrade
object
seqnum
string
Current sequence number of the channel.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
object
match_id
string
A unique identifier for the trade match event.

trade_price
string
The price at which the trade was executed.

trade_qty
string
The quantity of the asset traded.

liq_flag
string
Indicates whether the trade was executed as a taker or a maker.

Allowed values:
"TAKER"
"MAKER"
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "seqnum": "100001", "channel": "TRADE", "update": "UPDATE", "status": "AUTHENTICATED", "data": { "match_id": "1234576970", "trade_price": "75000.50", "trade_qty": "100.00", "liq_flag": "TAKER" } }

This example has been generated automatically.
RECEIVE /api/v1
Message sent from server containing the lasted exchange best bid and offer information for a subscribed instrument.

Operation IDebboFromServer
Available only on servers:
- uat
- production
Accepts the following message:
Message IDebbo
object
seqnum
string
Current sequence number of the channel.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
object
id
string
Exchange assigned ID of the market data.

status
string
Current market data state.

Allowed values:
"DISABLED"
"ENABLED"
object
object
price
string
qty
string
Additional properties are allowed.
object
price
string
qty
string
Additional properties are allowed.
object
price
string
qty
string
Additional properties are allowed.
last_update
string
A UTC Unix epoch in nanoseconds indicating when the book was last updated.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "seqnum": "20210209", "channel": "EBBO", "update": "SNAPSHOT", "status": "AUTHENTICATED", "data": { "id": "0987654321", "status": "ENABLED", "info": { "last_trade": { "price": "75.50", "qty": "1.5" }, "best_bid": { "price": "75.50", "qty": "1.5" }, "best_ask": { "price": "75.50", "qty": "1.5" }, "last_update": "123478909" } } }

This example has been generated automatically.

Messages

#1
Message IDsubscription
object
type
string
Action the request is intending to take.

Allowed values:
"SUBSCRIBE"
"SUBSCRIBE_NO_AUTH"
"UNSUBSCRIBE"
array<string>
List of items the request is intending to act upon.

Items:
string
array<string>
List of channels the request is intending to interact with.

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

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

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

signature
string
The computed HMAC signature.

Additional properties are allowed.
#2
Message IDwelcome
object
connections
string
Current number of active connections from the source IP.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
message
string
Message supplied when initiating a connection with the server.

version
string
Current version of the websocket API.

datetime
string
Current datetime of when the server sent the message,

Additional properties are allowed.
#3
Message IDconfirmation
object
timestamp
string
Server timestamp when the confirmation was generated.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
array<object>
object
channel
string
array<string>
Items:
string
Additional properties are allowed.
Additional properties are allowed.
#4
Message IDinstrument
object
seqnum
string
Current sequence number of the channel.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
object
id
string
Exchange assigned ID of the instrument.

status
string
Current instrument state.

Allowed values:
"DISABLED"
"OPENING"
"ACTIVE"
"HALTED"
object
symbol
string
<= 31 characters
Human readable representation of the instrument.

reference_price
string
Price used for initial price limit/band calcuations.

base_asset_id
string
ID of the base asset.

quote_asset_id
string
ID of the quote asset.

price_limit_window_secs
string
Number of seconds in the price limit's sliding window.

price_limit_percent
string
Specifies the percentage threshold for price movement beyond a reference price (e.g., the midpoint or previous close) at which the exchange will take action. If the price of a trade or order breaches this threshold, the exchange may halt trading, trigger a circuit breaker, or initiate other predefined actions to ensure market stability.

price_bands_percent
string
Defines the acceptable price range for order validation within the market. The price bands ensure that orders are priced within a range around the market's midpoint, adjusted for increments and thresholds.

Additional properties are allowed.
object
last_24hr_notional
string
The notional (quantity * price) amount of REFERENCE_ASSET traded over the last 24hr period.

last_24hr_quantity
string
The quantity traded over the last 24 hour period.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#5
Message IDtrade
object
seqnum
string
Current sequence number of the channel.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
object
match_id
string
A unique identifier for the trade match event.

trade_price
string
The price at which the trade was executed.

trade_qty
string
The quantity of the asset traded.

liq_flag
string
Indicates whether the trade was executed as a taker or a maker.

Allowed values:
"TAKER"
"MAKER"
Additional properties are allowed.
Additional properties are allowed.
#6
Message IDebbo
object
seqnum
string
Current sequence number of the channel.

channel
string
Channel this message orignated from.

Allowed values:
"WEBSOCKET"
"INSTRUMENT"
"TRADE"
"EBBO"
update
string
Type of update for the current message.

Allowed values:
"WELCOME"
"SNAPSHOT"
"UPDATE"
status
string
Current status of the websocket connection.

Allowed values:
"INVALID"
"ERROR"
"UNAUTHORIZED"
"UNAUTHENTICATED"
"AUTHENTICATED"
object
id
string
Exchange assigned ID of the market data.

status
string
Current market data state.

Allowed values:
"DISABLED"
"ENABLED"
object
object
price
string
qty
string
Additional properties are allowed.
object
price
string
qty
string
Additional properties are allowed.
object
price
string
qty
string
Additional properties are allowed.
last_update
string
A UTC Unix epoch in nanoseconds indicating when the book was last updated.

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.

Schemas

object
price
string
qty
string
Additional properties are allowed.
object
match_id
string
A unique identifier for the trade match event.

trade_price
string
The price at which the trade was executed.

trade_qty
string
The quantity of the asset traded.

liq_flag
string
Indicates whether the trade was executed as a taker or a maker.

Allowed values:
"TAKER"
"MAKER"
Additional properties are allowed.
object
id
string
Exchange assigned ID of the market data.

status
string
Current market data state.

Allowed values:
"DISABLED"
"ENABLED"
object
object
price
string
qty
string
Additional properties are allowed.
object
price
string
qty
string
Additional properties are allowed.
object
price
string
qty
string
Additional properties are allowed.
last_update
string
A UTC Unix epoch in nanoseconds indicating when the book was last updated.

Additional properties are allowed.
Additional properties are allowed.
object
last_24hr_notional
string
The notional (quantity * price) amount of REFERENCE_ASSET traded over the last 24hr period.

last_24hr_quantity
string
The quantity traded over the last 24 hour period.

Additional properties are allowed.
object
id
string
Exchange assigned ID of the instrument.

status
string
Current instrument state.

Allowed values:
"DISABLED"
"OPENING"
"ACTIVE"
"HALTED"
object
symbol
string
<= 31 characters
Human readable representation of the instrument.

reference_price
string
Price used for initial price limit/band calcuations.

base_asset_id
string
ID of the base asset.

quote_asset_id
string
ID of the quote asset.

price_limit_window_secs
string
Number of seconds in the price limit's sliding window.

price_limit_percent
string
Specifies the percentage threshold for price movement beyond a reference price (e.g., the midpoint or previous close) at which the exchange will take action. If the price of a trade or order breaches this threshold, the exchange may halt trading, trigger a circuit breaker, or initiate other predefined actions to ensure market stability.

price_bands_percent
string
Defines the acceptable price range for order validation within the market. The price bands ensure that orders are priced within a range around the market's midpoint, adjusted for increments and thresholds.

Additional properties are allowed.
object
last_24hr_notional
string
The notional (quantity * price) amount of REFERENCE_ASSET traded over the last 24hr period.

last_24hr_quantity
string
The quantity traded over the last 24 hour period.

Additional properties are allowed.
Additional properties are allowed.

Overview

Authentication

Links

Servers

Security:

Required members

Required members

Security:

Required members

Required members

Operations

SEND /api/v1

Examples

This example has been generated automatically.

RECEIVE /api/v1

Examples

This example has been generated automatically.

RECEIVE /api/v1

Examples

This example has been generated automatically.

RECEIVE /api/v1

Examples

This example has been generated automatically.

RECEIVE /api/v1

Examples

This example has been generated automatically.

RECEIVE /api/v1

Examples

This example has been generated automatically.

Messages

Schemas