For AI agents: the documentation index is at /llms.txt, and this page is available as Markdown at /api/institutional/get-clients-cefi.md.
Get clients
Query for a user's information.
JWTAuthorizationBearer <JWT>Present a True Markets-issued JWT access
token as Authorization: Bearer <token>, together with
x-truex-auth-timestamp (current Unix seconds, which guards against
replays). No request signing is required.
Obtain a token pair by exchanging a signed challenge for your
registered ES256 (EC P-256) API key at POST /v1/auth/api-key/token
(see the Auth API); the same token is issued by the standard sign-in
flows.
The token must carry a client_id claim, which scopes every request
to your CeFi client. The claim is present only once your account is
enabled for CeFi trading; a JWT without a client_id claim is
rejected with 401 Unauthorized.
id?stringID of client to query for.
^[1-9][0-9]*$1 <= lengthmnemonic?stringFilters clients by mnemonic (human readable text). Returns clients where the mnemonic is an exact match or contains the provided substring. Matching is case-sensitive.
x-truex-auth-timestamp*stringTimestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future. It guards against replayed requests.
Successful operation.
application/json- response
[index: integer]?curl -X GET 'https://api.truex.co/v1/cefi/clients' \ -H 'x-truex-auth-timestamp: string'[ { "id": "78901949710204932", "status": "ACTIVE", "info": { "organization_id": "ed671d2b-bb9e-4cf5-9eb4-71b6db672207", "mnemonic": "CLIENT1", "type": "INDIVIDUAL", "maker_fee_tier": 1, "taker_fee_tier": 2, "self_trade_prevention": "CANCEL_AGGRESSIVE" }, "controls": { "rate_limit_tier": 0, "instrument_entitlements": [ "SPOT" ], "flags": 0 } }]Compute market quote POST
Calculate a quote preview for an asset using current visible order book depth. Supports both base quantity and quote (notional) quantity via the required qty_unit parameter. For qty_unit=QUOTE, the exchange computes the largest executable base quantity that fits within the requested quote amount while respecting the instrument's base increment at the final consumed price level. As a result, the returned notional may be slightly less than the requested quote amount and the difference is reported in notional_residual.
Update settings PATCH
Update client level settings.