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

Request

Query for the exchange best bid/offer (EBBO) by instrument ID. If no query parameters are supplied then ALL available EBBOs will be returned.

Query
instrument_idstringnon-empty^[1-9][0-9]*$

Instrument ID of the market to query for. Must be a valid non-zero numeric ID.

curl -i -X GET \
  'https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/market/quote?instrument_id=string'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring^[1-9][0-9]*$

Exchange assigned ID of the market data.

Example: "78901949723181070"
symbolstring<= 31 characters

Human readable representation of the instrument.

Example: "BTC-PYUSD"
infoobject
]
Response
application/json
[ { "id": "78901949723181070", "symbol": "BTC-PYUSD", "info": { … } } ]

Request

Calculate a quote preview for an asset using current visible order book depth. Supports both base quantity and quote (notional) quantity via the required qty_unit parameter. In schema v2024_01_01, successful responses contain only qty and price. For qty_unit=QUOTE, the exchange computes the largest executable base quantity that fits within the requested quote amount while respecting the instrument's base increment at the final consumed price level. As a result, in schema v2026_01_23 the returned notional may be slightly less than the requested quote amount and the difference is reported in notional_residual.

Bodyapplication/jsonrequired

Quote request parameters. qty_unit is required and has no default.

qtystringnon-empty^[0-9]+(\.[0-9]+)?$required

The quantity to quote. Interpretation depends on qty_unit: for BASE this is the base asset amount, for QUOTE this is the notional (e.g. USD) amount.

Example: "1.5"
instrument_idstringnon-empty^[1-9][0-9]*$required

The instrument ID for which to calculate the quote. Must be a valid non-zero numeric ID.

Example: "1"
sidestringrequired

The side of the quote request. BUY calculates the price to buy the base asset, SELL calculates the price to sell.

Enum"BUY""SELL"
Example: "BUY"
qty_unitstringrequired

Unit of the qty field. BASE means qty is in base asset units, QUOTE means qty is in quote asset (notional) units. Required — no default.

Enum"BASE""QUOTE"
Example: "BASE"
curl -i -X POST \
  https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/markets/quote \
  -H 'Content-Type: application/json' \
  -d '{
    "qty": "1.5",
    "instrument_id": "1",
    "side": "BUY",
    "qty_unit": "BASE"
  }'

Responses

Successful operation.

Bodyapplication/json
qtystring

The base quantity. For qty_unit=QUOTE, this is the computed base amount. For qty_unit=BASE, this echoes back the requested base quantity.

Example: "1.5"
pricestring

The calculated VWAP (Volume-Weighted Average Price) across consumed order book levels.

Example: "50025.50"
notionalstring

Schema v2026_01_23 only. The expected quote amount consumed from visible order book liquidity.

Example: "75038.25"
notional_residualstring

Schema v2026_01_23 only. The unfilled portion of the requested quote amount. This is typically zero, but for qty_unit=QUOTE it can be positive when the remaining amount is smaller than one base increment at the final consumed price level.

Example: "0.10"
Response
application/json
{ "qty": "1.5", "price": "50025.50", "notional": "75038.25", "notional_residual": "0.10" }

Clients

Retrieve and update client account information and settings.

Operations

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.