Skip to content
APIs
/
/
/
All orders (deprecated)

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

Status order (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders/status/{ref_id} instead. Fetches the current status of a specific order identified by ref_id. The service retains status data for a limited period (currently 28 days), but this retention window is subject to change via configuration or system resource availability. ref_id must be one of the following:

  • The exchange assigned order ID.

  • UUID version 4 in its human readable form, with hypens, and in lowercase.

  • ASCII RFC 3986 compliant character string that does not exceed 18 characters.

    • Acceptable characters are a-z, A-Z, 0-9, -, _, ., ~
Security
HMAC
Path
ref_idstringrequired

ID of order to status.

Query
id_typestring

Type of ID the ref_id is, must be either 'client' or 'exchange'. If omitted will default to 'exchange'

Enum"client""exchange"
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/status/{ref_id}?id_type=client' \
  -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"
totalstring

Total notional (quantity X price) of the order.

Example: "3500000"
timestampstring

UNIX UTC nanosecond timestamp of when the order was created.

Example: "1752159930164131767"
update_timestampstring

UNIX UTC nanosecond timestamp of when the order was last updated.

Example: "1752159930192000004"
]
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",
    "total": "3500000",
    "timestamp": "1752159930164131767",
    "update_timestamp": "1752159930192000004"
  }
]

All orders (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders/list instead. Query for all orders placed on the exchange within the last 24 hours. A filter can be provided to limit the results.

Security
HMAC
Query
querystring

A serialized JSON object containing filter parameters. Filter orders by property, using $eq, $lt, $gt, $gte, $lte, $in operators.

Examples:
query={"columns":[{"name":"status","filter":[{"$in": ["REJECTED", "CANCELED"]}] }]}
skipinteger

The number of items to skip for pagination.

Default 0
Examples:
skip=10
sizeinteger[ 1 .. 100 ]

The number of items to return.

Default 10
Examples:
size=10
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/list?query=string&skip=0&size=10' \
  -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"
totalstring

Total notional (quantity X price) of the order.

Example: "3500000"
timestampstring

UNIX UTC nanosecond timestamp of when the order was created.

Example: "1752159930164131767"
update_timestampstring

UNIX UTC nanosecond timestamp of when the order was last updated.

Example: "1752159930192000004"
]
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",
    "total": "3500000",
    "timestamp": "1752159930164131767",
    "update_timestamp": "1752159930192000004"
  }
]

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"
  }
]

Balances

Operations

Transfers

Operations