Skip to content
APIs
/
/
/
Get service health

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

Get service health

Request

Returns the current readiness status for the REST API Gateway. The response includes a human-readable status indicator, the service name, and the timestamp when the status was generated.

curl -i -X GET \
  https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/health

Responses

Service is ready to handle requests.

Bodyapplication/json
statusstringrequired

Overall readiness indicator for the API.

Enum"healthy""degraded"
Example: "healthy"
timestampstringrequired

UTC timestamp the status was generated formatted as YYYY-MM-DD HH:MM:SS.

Example: "2025-01-15 14:30:00"
servicestringrequired

Name of the service reporting health.

Example: "rag"
Response
application/json
{
  "status": "healthy",
  "timestamp": "2025-01-15 14:30:00",
  "service": "rag"
}

Get supported API versions

Request

Returns a list of supported API versions with their deprecation status. Use this endpoint to discover available versions and plan migrations when versions are deprecated.

curl -i -X GET \
  https://docs.truemarkets.co/_mock/apis/cefi-direct/rest/v1/api/v1/versions

Responses

List of supported API versions.

Bodyapplication/json
supported_versionsArray of objects(ApiVersionInfo)required

List of all supported API versions.

supported_versions[].​versionstringrequired

The version identifier to use in the X-Truex-Version header.

Example: "v2024_01_01"
supported_versions[].​deprecatedbooleanrequired

Whether this version is deprecated and scheduled for removal.

Example: false
supported_versions[].​deprecation_datestring

HTTP-date format timestamp of when the version was deprecated. Only present if deprecated is true.

Example: "Sat, 01 Feb 2025 00:00:00 GMT"
supported_versions[].​sunset_datestring

HTTP-date format timestamp of when the version will be removed. Only present if deprecated is true.

Example: "Sun, 01 Feb 2026 00:00:00 GMT"
default_versionstringrequired

The version used when no X-Truex-Version header is provided.

Example: "v2024_01_01"
version_headerstringrequired

The header name to use for specifying API version.

Example: "X-Truex-Version"
Response
application/json
{
  "supported_versions": [
    { … }
  ],
  "default_version": "v2024_01_01",
  "version_header": "X-Truex-Version"
}

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

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.