Skip to content
APIs
/
/
/
Cancel order (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

Modify order (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders instead. Modify an existing active order request.

Security
HMAC
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.

Bodyapplication/jsonrequired

Order modify request context.

idstring

The internal order ID of the order to be modified. This is the id that was set by TrueX and should be a purely numeric string.

Example: "1159718398822187014"
external_idstring

The external ID for the order to be modified set 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: "123e7654-e89b-42d4-a456-426614174000"
infoobject(ModifyInfo)required
info.​msg_idstring

ID of last message to act upon the order.

Example: "0"
info.​parent_idstring

ID of the application creating the order, may be zero.

Example: "0"
info.​client_idstringrequired

The client ID the modification will be entered on behalf of.

Example: "0"
info.​prev_modifystring

ID of previous modify to act upon the order.

Example: "0"
info.​new_qtystringrequired

The new amount of base asset the order is requesting to tranasct.

Example: "0"
info.​new_pricestringrequired

The new highest or lowest price the order will buy or sell, respectively, at. Only required for LIMIT orders.

Example: "0"
info.​new_typestring

LIMIT orders may be converted to MARKET orders. The new MARKET order will immediately execute against the resting side of the order book providing there is available liquidity on the contra side of the request.

Value"MARKET"
Example: "MARKET"
curl -i -X PATCH \
  https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/order \
  -H 'Content-Type: application/json' \
  -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' \
  -d '{
    "id": "1159718398822187014",
    "external_id": "123e7654-e89b-42d4-a456-426614174000",
    "info": {
      "msg_id": "0",
      "parent_id": "0",
      "client_id": "0",
      "prev_modify": "0",
      "new_qty": "0",
      "new_price": "0",
      "new_type": "MARKET"
    }
  }'

Responses

Successful operation.

Bodyapplication/json
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": {
    "msg_id": "799477895858487977",
    "parent_id": "432351810263056385",
    "client_id": "78901949710204932",
    "instrument_id": "78901949723181070",
    "qty": "0.00145",
    "price": "111067",
    "flags": [ … ],
    "side": "BUY",
    "type": "LIMIT",
    "tif": "GTC",
    "exec_inst_flags": [ … ],
    "hold_fee_rate": "0.002",
    "stp": "NONE"
  },
  "modify_info": {
    "msg_id": "0",
    "parent_id": "0",
    "client_id": "0",
    "prev_modify": "0",
    "new_qty": "0",
    "new_price": "0",
    "new_type": "MARKET"
  },
  "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"
}

Cancel order (deprecated)Deprecated

Request

DEPRECATED: Use /api/v1/orders/{ref_id} instead. Begins the cancellation process of an existing active order from the exchange. N.B. it is still possible to recieve trades on the order that is being canceled. 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 cancel.

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 DELETE \
  'https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/order/{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/json
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": {
    "msg_id": "799477895858487977",
    "parent_id": "432351810263056385",
    "client_id": "78901949710204932",
    "instrument_id": "78901949723181070",
    "qty": "0.00145",
    "price": "111067",
    "flags": [ … ],
    "side": "BUY",
    "type": "LIMIT",
    "tif": "GTC",
    "exec_inst_flags": [ … ],
    "hold_fee_rate": "0.002",
    "stp": "NONE"
  },
  "modify_info": {
    "msg_id": "0",
    "parent_id": "0",
    "client_id": "0",
    "prev_modify": "0",
    "new_qty": "0",
    "new_price": "0",
    "new_type": "MARKET"
  },
  "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