Skip to content

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
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.
Operations
Operations
Operations
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_idstring

Instrument ID of the market to query for.

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

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring

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 VWAP (Volume-Weighted Average Price) quote for an asset based on a notional quantity (e.g. USD) across the order book.

Bodyapplication/jsonrequired

Quote request parameters.

qtystringrequired

The amount of quote asset (e.g., USD) to use for calculating the VWAP quote.

Example: "50000"
instrument_idstringrequired

The instrument ID for which to calculate the quote.

Example: "1"
curl -i -X POST \
  https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/market/quote \
  -H 'Content-Type: application/json' \
  -d '{
    "qty": "50000",
    "instrument_id": "1"
  }'

Responses

Successful operation.

Bodyapplication/json
quotestring

The calculated VWAP (Volume-Weighted Average Price) based on the order book.

Example: "50025.50"
buy_amountstring

The quantity of base asset (e.g., BTC) that can be purchased with the specified quote asset amount.

Example: "0.999"
Response
application/json
{ "quote": "50025.50", "buy_amount": "0.999" }
Operations
Operations
Operations
Operations