Skip to content
APIs
/
/
/
Get clients

True Markets CeFi REST (v1.0.4)

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
v1.json
v1.yaml
Overview
E-mail

info@truex.co

Terms of Service

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

Get clients

Request

Query for a user's information.

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

ID of client to query for.

mnemonicstring

Filters clients by mnemonic (human readable text). Returns clients where the mnemonic is an exact match or contains the provided substring. Matching is case-sensitive.

Headers
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/clients?id=string&mnemonic=string' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: YOUR_API_KEY_HERE'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring^[1-9][0-9]*$
Example: "78901949710204932"
statusstring

Current client state.

Enum"INITIIALIZED""ACTIVE""DISABLED"
Example: "ACTIVE"
infoobject
]
Response
application/json
[
  {
    "id": "78901949710204932",
    "status": "ACTIVE",
    "info": { … }
  }
]

Update settings

Request

Update client level settings.

Security
HMAC
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.

Bodyapplication/jsonrequired

Client settings context.

idstring^[1-9][0-9]*$required
Example: "78901949710270469"
infoobject
curl -i -X PATCH \
  https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/clients \
  -H 'Content-Type: application/json' \
  -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' \
  -d '{
    "id": "78901949710270469",
    "info": {
      "self_trade_prevention": "CANCEL_BOTH"
    }
  }'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring^[1-9][0-9]*$
Example: "78901949710204932"
statusstring

Current client state.

Enum"INITIIALIZED""ACTIVE""DISABLED"
Example: "ACTIVE"
infoobject
]
Response
application/json
[
  {
    "id": "78901949710204932",
    "status": "ACTIVE",
    "info": { … }
  }
]

Get clients (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/clients instead. Query for a user's information.

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

ID of client to query for.

mnemonicstring

Filters clients by mnemonic (human readable text). Returns clients where the mnemonic is an exact match or contains the provided substring. Matching is case-sensitive.

Headers
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/client?id=string&mnemonic=string' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: YOUR_API_KEY_HERE'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring^[1-9][0-9]*$
Example: "78901949710204932"
statusstring

Current client state.

Enum"INITIIALIZED""ACTIVE""DISABLED"
Example: "ACTIVE"
infoobject
]
Response
application/json
[
  {
    "id": "78901949710204932",
    "status": "ACTIVE",
    "info": { … }
  }
]

Update settings (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/clients instead. Update client level settings.

Security
HMAC
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.

Bodyapplication/jsonrequired

Client settings context.

idstring^[1-9][0-9]*$required
Example: "78901949710270469"
infoobject
curl -i -X PATCH \
  https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/client \
  -H 'Content-Type: application/json' \
  -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' \
  -d '{
    "id": "78901949710270469",
    "info": {
      "self_trade_prevention": "CANCEL_BOTH"
    }
  }'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring^[1-9][0-9]*$
Example: "78901949710204932"
statusstring

Current client state.

Enum"INITIIALIZED""ACTIVE""DISABLED"
Example: "ACTIVE"
infoobject
]
Response
application/json
[
  {
    "id": "78901949710204932",
    "status": "ACTIVE",
    "info": { … }
  }
]

Orders

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

Operations

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.