Skip to content
APIs
/
CeFi
/
REST
/
Transfers

TrueX REST API (1.0.0)

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.

Download OpenAPI description
v1.json
v1.yaml
Overview
E-mail

info@truex.co

Terms of Service

Languages
Servers
Mock server

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

https://prod.truex.co/

Assets

Operations

Instruments

Operations

Market Data

Operations

Clients

Operations

Orders

Operations

Balances

Operations

Transfers

Operations

Get Active transfers

Request

Fetches all currently active transfers on the exchange. If a transfer_id is provided, returns details for the specified transfer. Otherwise, retrieves all active transfers for the authenticated client.

Security
HMAC
Query
transfer_idstring

Unique identifier of a specific transfer. If omitted, all active transfers for the client will be returned.

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/transfer/active?transfer_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 response with active transfers.

Bodyapplication/jsonArray [
idstring
Example: "1234576970"
statusstring
Enum"INITIALIZED""PENDING""COMPLETED""FAILED""REJECTED"
Example: "INITIALIZED"
requestobject(TransferNew)
]
Response
application/json
[
  {
    "id": "1234576970",
    "status": "INITIALIZED",
    "request": { … }
  }
]

Get transfer

Request

Fetches all transfers for a client within the past 24 hours on the exchange.

Security
HMAC
Query
sizestring

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

skipstring

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

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

A Unix timestamp in UTC nanoseconds (e.g., 1741523275598727336) that serves as the reference point for fetching transfers. This ensures precise time-based filtering and 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/transfer?size=string&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 response with a list of transfers.

Bodyapplication/jsonArray [
idstring
Example: "1234576970"
statusstring
Enum"INITIALIZED""PENDING""COMPLETED""FAILED""REJECTED"
Example: "INITIALIZED"
requestobject(TransferNew)
timestampstring(int64)

Nanosecond timestamp of when the transfer was initiated.

Example: "1740740509058376312"
updated_timestampstring(int64)

Nanosecond timestamp of the last update to the transfer.

Example: "1740740509058376312"
]
Response
application/json
[
  {
    "id": "1234576970",
    "status": "INITIALIZED",
    "request": { … },
    "timestamp": "1740740509058376312",
    "updated_timestamp": "1740740509058376312"
  }
]

Initiate transfer

Request

Initiate a new transfer of assets to/from the exchange.

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

Transfer request object.

requestobject(TransferNew)
curl -i -X POST \
  https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/transfer \
  -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 '{
    "request": {
      "asset_id": "1234576970",
      "client_id": "1234576970",
      "amount": "1000000.00",
      "type": "WITHDRAW",
      "platform": "FIAT",
      "instructions": {
        "fiat_account_id": "ed671d2b-bb9e-4cf5-9eb4-71b6db672207",
        "identity_id": "b2a99c93-f1ee-41ed-9e9e-ec704cfbca4b",
        "account_id": "b2a99c93-f1ee-41ed-9e9e-ec704cfbca4b",
        "includes_fee": true
      }
    }
  }'

Responses

Successful operation.

Bodyapplication/json
idstring
Example: "1234576970"
statusstring
Enum"INITIALIZED""PENDING""COMPLETED""FAILED""REJECTED"
Example: "INITIALIZED"
requestobject(TransferNew)
Response
application/json
{
  "id": "1234576970",
  "status": "INITIALIZED",
  "request": {
    "asset_id": "1234576970",
    "client_id": "1234576970",
    "amount": "1000000.00",
    "type": "WITHDRAW",
    "platform": "FIAT",
    "instructions": { … }
  }
}