REST
/
Balances
/
Get balance

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
License TrueX License
 Terms of Service
Languages
Servers
Mock server
https://docs.truex.co/_mock/rest/v1/
https://prod.truex.co/

Assets

Operations

Instruments

Operations

Market Data

Operations

Clients

Operations

Orders

Operations

Balances

Operations

Get balance

Request

Query for balance information current allocated to the exchange.

Query
asset_idstring

ID of asset to query balance information 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.truex.co/_mock/rest/v1/api/v1/balance?asset_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

Exchange assigned entity ID.

Example: "0987654321"
statusstring

Exchange only status value, will always bee INVALID.

Value"INVALID"
Example: "INVALID"
unsettled_feesstring

Current amount of fee asset that have been accrued due to trading but have yet to be settled with the exchange.

Example: "-0.25"
fees_holdstring

Current amount of fee asset that is being held by the exchange as a result of trading activity.

Example: "1.15"
balancesArray of objects(Balance)
]
Response
application/json
[
  {
    "id": "0987654321",
    "status": "INVALID",
    "unsettled_fees": "-0.25",
    "fees_hold": "1.15",
    "balances": [ … ]
  }
]

Transfers

Operations