For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/institutional/get-balances-cefi.md.

Get balance

GET
/v1/cefi/balances

Query for balance information current allocated to the exchange.

Authorization

headerx-truex-auth-token<token>

Legacy authentication, being phased out in favour of JWT. Clients must compute and send an HMAC signature in x-truex-auth-signature.

Compute the payload exactly as:

timestamp + method + path + body

Then compute the signature as:

Base64( HMAC_SHA256(secret, payload) )

Rules:

  • timestamp is x-truex-auth-timestamp in seconds since Unix epoch.
  • timestamp must be no older than 15 seconds and no more than 1 second in the future.
  • method is uppercase HTTP method (GET, POST, DELETE, etc.).
  • path is everything after the domain, including the leading / and the raw query string exactly as sent, still percent-encoded (e.g. /v1/cefi/orders/EXT-1?id_type=client). Leave out the ? when the query is empty.
  • Signatures over the path without its query are still accepted while signers move over.
  • body is the exact raw request body string. Use an empty string for requests with no body.

Example payload:

  • 1700000000POST/v1/cefi/orders{"client_id":"7","instrument_id":"1","qty":"1","price":"100"}

Example signature (shell):

  • printf '%s' "$PAYLOAD" | openssl dgst -sha256 -hmac "$SECRET" -binary | base64

Required headers:

  • x-truex-auth-token: The ID of the HMAC key being used (API key).
  • x-truex-auth-signature: The signature generated from processing the payload with the HMAC key.
  • x-truex-auth-timestamp: Current time as seconds since epoch.
  • x-truex-auth-userid: Client identifier, for organization keys. It is not signed, so keys that act on behalf of any client ignore it and name the client in the query or body.

Query Parameters

asset_id?string

ID of asset to query balance information for.

Match^[1-9][0-9]*$
Length1 <= length
asset_name?string

Name of asset to query balance information for. ASCII alphanumeric only.

Match^[a-zA-Z0-9_-]+$
Length1 <= length
client_id?string

Exchange generated client ID to query balance information for.

Match^[1-9][0-9]*$
Length1 <= length

Header Parameters

x-truex-auth-userid?string

HMAC only. The client the request acts for. Omit it with a JWT, which carries your client id.

x-truex-auth-timestamp*string

Timestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future. Required with both JWT and HMAC authentication; it guards against replayed requests.

x-truex-auth-token?string

HMAC only. The UUID affiliated with the HMAC key. Omit it with a JWT.

x-truex-auth-signature?string

HMAC only. The computed HMAC signature. Omit it with a JWT.

Response Body

Successful operation.

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.truex.co/v1/cefi/balances' \  -H 'x-truex-auth-timestamp: string'
Example Response
[  {    "id": "78901985055342602",    "status": "INVALID",    "unsettled_fees": "9210.236229375",    "fees_hold": "179300.4249165",    "balances": [      {        "asset_id": "78901985048264711",        "balance": "10000000.45",        "unsettled": "0",        "order_hold": "3586008.49833",        "transfer_hold": "100.00",        "state": "OPEN"      }    ]  }]