Skip to content
APIs
/
CeFi
/
/Instruments

TrueX REST API (v1.0.3)

Overview

This API allows clients to interact with the TrueX 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": { "limit": 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

License

TrueX License

Terms of Service

Languages
Servers
Mock server

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

https://prod.truex.co/

Change Log

VersionDateNotes
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.

Service

Operations

Assets

Operations

Instruments

Operations

Get instruments

Request

Query for instruments available on the exchange by specific instrument ID or symbol. If no query parameters are supplied than ALL available instruments will be returned.

Query
idstring

ID of instrument to query for.

symbolstring

Filters instruments by symbol. Returns instruments where the symbol is an exact match or contains the provided substring. Matching is case-sensitive.

curl -i -X GET \
  'https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/instruments?id=string&symbol=string'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring

Exchange assigned ID of the instrument.

Example: "78901949723181070"
statusstring

Current instrument state.

Enum"DISABLED""OPENING""ACTIVE""HALTED"
Example: "ACTIVE"
infoobject
statsobject(InstrumentStat)
]
Response
application/json
[
  {
    "id": "78901949723181070",
    "status": "ACTIVE",
    "info": { … },
    "stats": { … }
  }
]

Get instruments (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/instruments instead. Query for instruments available on the exchange by specific instrument ID or symbol. If no query parameters are supplied than ALL available instruments will be returned.

Query
idstring

ID of instrument to query for.

symbolstring

Filters instruments by symbol. Returns instruments where the symbol is an exact match or contains the provided substring. Matching is case-sensitive.

curl -i -X GET \
  'https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/instrument?id=string&symbol=string'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring

Exchange assigned ID of the instrument.

Example: "78901949723181070"
statusstring

Current instrument state.

Enum"DISABLED""OPENING""ACTIVE""HALTED"
Example: "ACTIVE"
infoobject
statsobject(InstrumentStat)
]
Response
application/json
[
  {
    "id": "78901949723181070",
    "status": "ACTIVE",
    "info": { … },
    "stats": { … }
  }
]

Market Data

Operations

Clients

Operations

Orders

Operations

Balances

Operations

Transfers

Operations