Skip to content
APIs
/
CeFi
/
REST
/
Clients
/
Get clients

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

Get clients

Request

Query for a user's information.

Security
HMAC
Query
idstring

ID of client to query for.

mnemonicstring

Client mnenomic (human readable text) 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/client?id=string&mnemonic=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: "0987654321"
statusstring

Current client state.

Enum"INITIIALIZED""ACTIVE""DISABLED"
Example: "ACTIVE"
infoobject
]
Response
application/json
[
  {
    "id": "0987654321",
    "status": "ACTIVE",
    "info": { … }
  }
]

Update client settings

Request

Update client level settings.

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

Client settings context.

idstring
Example: "1234567890"
infoobject
curl -i -X PATCH \
  https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/client \
  -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": "1234567890",
    "info": {
      "self_trade_prevention": "CANCEL_BOTH"
    }
  }'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring
Example: "0987654321"
statusstring

Current client state.

Enum"INITIIALIZED""ACTIVE""DISABLED"
Example: "ACTIVE"
infoobject
]
Response
application/json
[
  {
    "id": "0987654321",
    "status": "ACTIVE",
    "info": { … }
  }
]

Orders

Operations

Balances

Operations

Transfers

Operations