Skip to content

Overview

This API allows clients to interact with the CeFi trading platform for order management, market data retrieval, and account information.

Base URL

https://prod.truex.co/api/v1/

Authentication

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

API Versioning

The API uses date-based versioning via the X-Truex-Version header. To request a specific API version, include the header in your request:

X-Truex-Version: v2024_01_01

Supported Versions:

VersionStatusDescription
v2024_01_01Current (Default)Original API format - responses return raw data arrays/objects
v2026_01_23CurrentNew envelope format - responses wrapped in { "data": [...], "pagination": {...} }

If no version header is provided, the API defaults to v2024_01_01. Use the /api/v1/versions endpoint to discover supported versions programmatically.

Response Format by Version:

  • v2024_01_01: [{...}, {...}] (raw array) or {...} (raw object)
  • v2026_01_23: { "data": [...], "pagination": { "size": 10, "next_cursor": "..." } }

Error Response Format by Version:

  • v2024_01_01: RFC 7807 Problem Details format
  • v2026_01_23: { "error": { ...RFC 7807 Problem Details... } }

Deprecation Policy: When a version is deprecated, responses will include RFC 8594 headers:

  • Deprecation: Date when the version was deprecated
  • Sunset: Date when the version will be removed
Download OpenAPI description
Languages
Servers
Mock server

https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/

https://prod.truex.co/

Service

Health checks and API version discovery endpoints. These endpoints are publicly accessible and do not require authentication.

Operations

Assets

Query available assets on the exchange by ID or name.

Operations

Instruments

Query tradeable instruments (market definitions) and their statistics.

Operations

Market Data

Real-time market quotes and VWAP computations. These endpoints are publicly accessible and do not require authentication.

Operations

Clients

Retrieve and update client account information and settings.

Operations

Orders

Create, modify, cancel, and query orders including status, trades, and activity history.

Operations

Request

Query for orders currently active on the exchange.

Security
HMAC
Query
idstringnon-empty^[1-9][0-9]*$

ID of order to query for.

Headers
x-truex-auth-useridstringrequired

Client identifier.

x-truex-auth-timestampstringrequired

Timestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future.

x-truex-auth-tokenstringrequired

The UUID affiliated with the HMAC key.

x-truex-auth-signaturestringrequired

The computed HMAC signature.

curl -i -X GET \
  'https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/orders/active?id=string' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: YOUR_API_KEY_HERE' \
  -H 'x-truex-auth-userid: string'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring
Example: "799477895858487977"
statusstring

The current status of the order.

  • INITIALIZED Order has been created, but not sent yet.
  • NEW_PENDING Order has been sent, but not confirmed by the exchange or downstream process.
  • REJECTED An order setting or market condition prevents the order from getting processed.
  • ACTIVE The order was accepted by the system and open to trading (order and market conditions permitting).
  • FILLED The entire order traded.
  • CANCEL_PENDING Indicates a cancel request was received and being processed.
  • CANCELED The order was canceled from a cancel request, order conditions, or market conditions.
  • MODIFY_PENDING Indicates a modification request was received and being processed.
Enum"INITIALIZED""NEW_PENDING""REJECTED""ACTIVE""FILLED""CANCEL_PENDING""CANCELED""MODIFY_PENDING"
Example: "ACTIVE"
order_infoobject(OrderInfo)
modify_infoobject(ModifyInfo)
external_idstring

A unique identifier created by the client. Must be in one of the following formats:

  • UUID version 4 in its human readable form, with hypens, and in lowercase.
  • ASCII character string of up to 18 characters containing only the unreserved URL characters: letters (a–z, A–Z), digits (0–9), hyphen (-), underscore (_), period (.), and tilde (~).
Example: "EXT-ORDER-123"
ref_external_idstring

A unique identifier created by the client. Must be in one of the following formats:

  • UUID version 4 in its human readable form, with hypens, and in lowercase.
  • ASCII character string of up to 18 characters containing only the unreserved URL characters: letters (a–z, A–Z), digits (0–9), hyphen (-), underscore (_), period (.), and tilde (~).
Example: "REF-EXT-ORDER-123"
pending_qtystring

Order quantity that has been acknowledge by the exchange but is not yet trading.

Example: "0"
leaves_qtystring

Order quantity that is currently active in the market.

Example: "0.00145"
exeuted_qtystring

Amount of quantity currently executed.

Example: "0.00239"
executed_vwapstring

Volume weighted average price calculation for all executions on the order.

Example: "111050.5"
]
Response
application/json
[ { "id": "799477895858487977", "status": "ACTIVE", "order_info": { … }, "modify_info": { … }, "external_id": "EXT-ORDER-123", "ref_external_id": "REF-EXT-ORDER-123", "pending_qty": "0", "leaves_qty": "0.00145", "exeuted_qty": "0.00239", "executed_vwap": "111050.5" } ]

Request

Fetches all trades for a client executed within the past 24 hours on the exchange.

Security
HMAC
Query
sizeinteger[ 1 .. 100 ]

Number of records to return per page. Maximum allowed value is 100.

Default 10
skipinteger[ 0 .. 2147483647 ]

Number of records to skip before returning results.

timestampstring^[0-9]{19}$required

A Unix UTC timestamp in nanoseconds used as a reference point for fetching trades.

Example: timestamp=1741523275598727336
client_idstring

Comma-separated list of client IDs to filter results. Only returns trades for the specified clients.

Example: client_id=78901968715907076
Headers
x-truex-auth-useridstringrequired

Client identifier.

x-truex-auth-timestampstringrequired

Timestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future.

x-truex-auth-tokenstringrequired

The UUID affiliated with the HMAC key.

x-truex-auth-signaturestringrequired

The computed HMAC signature.

curl -i -X GET \
  'https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/orders/trade?size=10&skip=2147483647&timestamp=1741523275598727336&client_id=78901968715907076' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: YOUR_API_KEY_HERE' \
  -H 'x-truex-auth-userid: string'

Responses

Successful operation.

Bodyapplication/jsonArray [
client_idstringrequired

A unique identifier assigned to the client.

Example: "78975249877368840"
external_idstring

An external identifier for the order.

Example: "550e8400-e29b-41d4-a716-446655440000"
instrument_idstringrequired

A unique identifier for the trading instrument.

Example: "78975249883267118"
msg_typestringrequired

The type of activity event.

Enum"REPORT_TRADE""REQUEST_NEW""REQUEST_CANCEL""REQUEST_MODIFY""REPORT_CONFIRM""REPORT_REJECT""REPORT_CANCELED""REPORT_MODIFIED"
timestampstringrequired

The Unix UTC timestamp (in nanoseconds) when the activity occurred.

Example: "1770919994854735762"
sidestringrequired

The side of the order (BUY/SELL).

Enum"BUY""SELL"
Example: "BUY"
order_idstringrequired

A unique identifier for the order.

Example: "2312760665443598349"
trade_pricestring

The price at which the trade was executed.

Example: "111480.5"
trade_qtystring

The quantity of the asset traded.

Example: "0.06089"
trade_fee_ratestring

The fee rate applied to the trade.

Example: "0.0005"
liq_flagstring

Liquidity flag indicating whether the order was a maker or taker.

Enum"TAKER""MAKER"
Example: "TAKER"
match_idstring

A unique identifier for the trade match.

Example: "147670564223998146302870408890920992792"
]
Response
application/json
[ { "client_id": "78975249877368840", "external_id": "550e8400-e29b-41d4-a716-446655440000", "instrument_id": "78975249883267118", "msg_type": "REPORT_TRADE", "timestamp": "1770919994854735762", "side": "BUY", "order_id": "2312760665443598349", "trade_price": "111480.5", "trade_qty": "0.06089", "trade_fee_rate": "0.0005", "liq_flag": "TAKER", "match_id": "147670564223998146302870408890920992792" } ]

Request

Fetches all activity (trades, confirms, rejects, cancels, modifications) for a client's orders.

Security
HMAC
Query
sizestring[ 1 .. 100 ]

Number of records to return per page. Maximum allowed value is 100.

Default 10
skipstring

Number of records to skip before returning results.

timestampstring^[0-9]{19}$required

A Unix UTC timestamp in nanoseconds used as a reference point for fetching activity.

Example: timestamp=1741523275598727336
client_idstring

Comma-separated list of client IDs to filter results.

Example: client_id=78901968715907076
order_idstring

Comma-separated list of order IDs to filter results.

Example: order_id=8005237327190949926
msg_typestring

Comma-separated list of activity message types to filter results (e.g., REPORT_TRADE,REPORT_CONFIRM).

Example: msg_type=REPORT_TRADE
Headers
x-truex-auth-useridstringrequired

Client identifier.

x-truex-auth-timestampstringrequired

Timestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future.

x-truex-auth-tokenstringrequired

The UUID affiliated with the HMAC key.

x-truex-auth-signaturestringrequired

The computed HMAC signature.

curl -i -X GET \
  'https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/orders/activity?size=10&skip=string&timestamp=1741523275598727336&client_id=78901968715907076&order_id=8005237327190949926&msg_type=REPORT_TRADE' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: YOUR_API_KEY_HERE' \
  -H 'x-truex-auth-userid: string'

Responses

Successful operation.

Bodyapplication/jsonArray [
client_idstringrequired

A unique identifier assigned to the client.

Example: "78975249877368840"
external_idstring

An external identifier for the order.

Example: "550e8400-e29b-41d4-a716-446655440000"
instrument_idstringrequired

A unique identifier for the trading instrument.

Example: "78975249883267118"
msg_typestringrequired

The type of activity event.

Enum"REQUEST_NEW""REQUEST_CANCEL""REQUEST_MODIFY""REPORT_CONFIRM""REPORT_REJECT""REPORT_TRADE""REPORT_CANCELED""REPORT_MODIFIED"
Discriminator
timestampstringrequired

The Unix UTC timestamp (in nanoseconds) when the activity occurred.

Example: "1770919994854735762"
sidestringrequired

The side of the order (BUY/SELL).

Enum"BUY""SELL"
Example: "BUY"
order_pricestring

The requested order price.

Example: "66000"
order_qtystring

The requested order quantity.

Example: "0.0001"
]
Response
application/json
[ { "client_id": "78975249877368840", "external_id": "550e8400-e29b-41d4-a716-446655440000", "instrument_id": "78975249883267118", "msg_type": "REQUEST_NEW", "timestamp": "1770919994854735762", "side": "BUY", "order_price": "66000", "order_qty": "0.0001" } ]

Balances

Query account balances across all assets.

Operations

Transfers

Initiate and track fund transfers between accounts.

Operations

Change Log

VersionDateNotes
v1.0.42026-03-12Compute quote now works for both base and qoute bases.
v1.0.32026-01-27Pluralize all endpoints. Deprecate singular versions.
v1.0.22026-01-24Add API versioning support and versions endpoint.
v1.0.12025-10-24Add gateway health endpoint.
v1.0.02025-10-16Initial Release.