Skip to content
APIs
/
/
/
All order trades (depreca...

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

Market Data

Operations

Clients

Operations

Orders

Operations

Active orders (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders/active instead. Query for orders currently active on the exchange. An order ID may be supplied to query for a specific order, if this query parameter is not supplied then all active orders will be returned.

Security
HMAC
Query
idstring

ID of order to query for.

Headers
x-truex-auth-useridstringrequired

Client identifier.

x-truex-auth-timestampstringrequired

Timestamp when request was made in seconds since epoch.

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/rest/v1/api/v1/order/active?id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: string' \
  -H 'x-truex-auth-userid: string'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring
Example: "799477895858487977"
statusstring

The current status of the order.

  • INITIALIZED Order has been created, but not sent yet.
  • NEW_PENDING Order has been sent, but not confirmed by the exchange or downstream process.
  • REJECTED An order setting or market condition prevents the order from getting processed.
  • ACTIVE The order was accepted by the system and open to trading (order and market conditions permitting).
  • FILLED The entire order traded.
  • CANCEL_PENDING Indicates a cancel request was received and being processed.
  • CANCELED The order was canceled from a cancel request, order conditions, or market conditions.
  • MODIFY_PENDING Indicates a modification request was received and being processed.
Enum"INITIALIZED""NEW_PENDING""REJECTED""ACTIVE""FILLED""CANCEL_PENDING""CANCELED""MODIFY_PENDING"
Example: "ACTIVE"
order_infoobject(OrderInfo)
modify_infoobject(ModifyInfo)
external_idstring

A unique identifier created by the client. Must be in one the follower formats:

  • UUID version 4 in its human readable form, with hypens, and in lowercase.
  • ASCII character string of up to 18 characters containing only the unreserved URL characters: letters (a–z, A–Z), digits (0–9), hyphen (-), underscore (_), period (.), and tilde (~).
Example: "EXT-ORDER-123"
ref_external_idstring

A unique identifier created by the client. Must be in one the follower formats:

  • UUID version 4 in its human readable form, with hypens, and in lowercase.
  • ASCII character string of up to 18 characters containing only the unreserved URL characters: letters (a–z, A–Z), digits (0–9), hyphen (-), underscore (_), period (.), and tilde (~).
Example: "REF-EXT-ORDER-123"
pending_qtystring

Order quantity that has been acknowledge by the exchange but is not yet trading.

Example: "0"
leaves_qtystring

Order quantity that is currently active in the market.

Example: "0.00145"
exeuted_qtystring

Amount of quantity currently executed.

Example: "0.00239"
executed_vwapstring

Volume weighted average price calculation for all executions on the order.

Example: "111050.5"
]
Response
application/json
[
  {
    "id": "799477895858487977",
    "status": "ACTIVE",
    "order_info": { … },
    "modify_info": { … },
    "external_id": "EXT-ORDER-123",
    "ref_external_id": "REF-EXT-ORDER-123",
    "pending_qty": "0",
    "leaves_qty": "0.00145",
    "exeuted_qty": "0.00239",
    "executed_vwap": "111050.5"
  }
]

All order trades (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders/trade instead. Fetches all trades for a client executed within the past 24 hours on the exchange. A filter can be provided to limit the results.

Security
HMAC
Query
sizestring[ 1 .. 100 ]

Number of records to return per page. Maximum allowed value is 100.

Default 10
skipstring

Number of records to skip before returning results. Used for offset-based pagination.

timestampstring^[0-9]{19}$required

A Unix UTC timestamp in nanoseconds used as a reference point for fetching trades. The query will retrieve results created before this timestamp, enabling precise time-based filtering and ensuring stable pagination. If omitted, the server responds with 400 BAD REQUEST.

Example: timestamp=1741523275598727336
Headers
x-truex-auth-useridstringrequired

Client identifier.

x-truex-auth-timestampstringrequired

Timestamp when request was made in seconds since epoch.

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/rest/v1/api/v1/order/trade?size=10&skip=string&timestamp=1741523275598727336' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: string' \
  -H 'x-truex-auth-userid: string'

Responses

Successful operation.

Bodyapplication/jsonArray [
client_idstring

A unique identifier assigned to the client.

Example: "78901968715907076"
instrument_idstring

A unique identifier for the trading instrument.

Example: "78901968728948750"
order_idstring

A unique identifier for the order.

Example: "8005237327190949926"
trade_pricestring

The price at which the trade was executed.

Example: "111480.5"
trade_qtystring

The quantity of the asset traded.

Example: "0.06089"
trade_fee_ratestring

The fee rate applied to the trade.

Example: "0.0005"
liq_flagstring

Indicates whether the trade was executed as a taker or a maker.

Enum"TAKER""MAKER"
Example: "TAKER"
match_idstring

A unique identifier for the trade match event.

Example: "147670564223998146302870408890920992792"
timestampstring

The Unix UTC timestamp (in nanoseconds) when the trade was executed.

Example: "1752163579133484200"
]
Response
application/json
[
  {
    "client_id": "78901968715907076",
    "instrument_id": "78901968728948750",
    "order_id": "8005237327190949926",
    "trade_price": "111480.5",
    "trade_qty": "0.06089",
    "trade_fee_rate": "0.0005",
    "liq_flag": "TAKER",
    "match_id": "147670564223998146302870408890920992792",
    "timestamp": "1752163579133484200"
  }
]

Get orders (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders instead. Fetches all orders for a client entered within the past 24 hours on the exchange. A filter can be provided to limit the results.

Security
HMAC
Query
sizestring[ 1 .. 100 ]

Number of records to return per page. Maximum allowed value is 100.

Default 10
skipstring

Number of records to skip before returning results. Used for offset-based pagination.

timestampstring^[0-9]{19}$required

A Unix UTC timestamp in nanoseconds used as a reference point for fetching orders. The query will retrieve results created before this timestamp, enabling precise time-based filtering and ensuring stable pagination. If omitted, the server responds with 400 BAD REQUEST.

Example: timestamp=1741523275598727336
Headers
x-truex-auth-useridstringrequired

Client identifier.

x-truex-auth-timestampstringrequired

Timestamp when request was made in seconds since epoch.

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/rest/v1/api/v1/order?size=10&skip=string&timestamp=1741523275598727336' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-truex-auth-signature: string' \
  -H 'x-truex-auth-timestamp: string' \
  -H 'x-truex-auth-token: string' \
  -H 'x-truex-auth-userid: string'

Responses

Successful operation.

Bodyapplication/jsonArray [
client_idstring

A unique identifier assigned to the client.

Example: "78901968715907076"
instrument_idstring

A unique identifier for the trading instrument.

Example: "78901968728948750"
order_idstring

A unique identifier for the order.

Example: "8005237327190949926"
trade_pricestring

The price at which the trade was executed.

Example: "111480.5"
trade_qtystring

The quantity of the asset traded.

Example: "0.06089"
trade_fee_ratestring

The fee rate applied to the trade.

Example: "0.0005"
liq_flagstring

Indicates whether the trade was executed as a taker or a maker.

Enum"TAKER""MAKER"
Example: "TAKER"
match_idstring

A unique identifier for the trade match event.

Example: "147670564223998146302870408890920992792"
timestampstring

The Unix UTC timestamp (in nanoseconds) when the trade was executed.

Example: "1752163579133484200"
]
Response
application/json
[
  {
    "client_id": "78901968715907076",
    "instrument_id": "78901968728948750",
    "order_id": "8005237327190949926",
    "trade_price": "111480.5",
    "trade_qty": "0.06089",
    "trade_fee_rate": "0.0005",
    "liq_flag": "TAKER",
    "match_id": "147670564223998146302870408890920992792",
    "timestamp": "1752163579133484200"
  }
]

Balances

Operations

Transfers

Operations