Returns the current readiness status for the REST API Gateway. The response includes a human-readable status indicator, the service name, and the timestamp when the status was generated.
TrueX REST API (v1.0.3)
This API allows clients to interact with the TrueX trading platform for order management, market data retrieval, and account information.
Certain API requests must be authenticated using HMAC-SHA256 signature authentication.
The API uses date-based versioning via the X-Truex-Version header. To request a specific API version, include the header in your request:
X-Truex-Version: v2024_01_01Supported Versions:
| Version | Status | Description |
|---|---|---|
v2024_01_01 | Current (Default) | Original API format - responses return raw data arrays/objects |
v2026_01_23 | Current | New envelope format - responses wrapped in { "data": [...], "pagination": {...} } |
If no version header is provided, the API defaults to v2024_01_01. Use the /api/v1/versions endpoint to discover supported versions programmatically.
Response Format by Version:
- v2024_01_01:
[{...}, {...}](raw array) or{...}(raw object) - v2026_01_23:
{ "data": [...], "pagination": { "limit": 10, "next_cursor": "..." } }
Error Response Format by Version:
- v2024_01_01: RFC 7807 Problem Details format
- v2026_01_23:
{ "error": { ...RFC 7807 Problem Details... } }
Deprecation Policy: When a version is deprecated, responses will include RFC 8594 headers:
Deprecation: Date when the version was deprecatedSunset: Date when the version will be removed
- 📖 Full API Documentation: https://docs.truex.co/
- 📧 Support: support@truex.co
Overview
Languages
Servers
Mock server
https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/
https://prod.truex.co/
- Mock server
https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/health
https://prod.truex.co/api/v1/health
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/healthResponse
application/json
{ "status": "healthy", "timestamp": "2025-01-15 14:30:00", "service": "rag" }
- Mock server
https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/versions
https://prod.truex.co/api/v1/versions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.truemarkets.co/_mock/apis/cefi/rest/v1/api/v1/versionsList of supported API versions.
List of all supported API versions.
The version identifier to use in the X-Truex-Version header.
Example: "v2024_01_01"
Whether this version is deprecated and scheduled for removal.
Example: false
HTTP-date format timestamp of when the version was deprecated. Only present if deprecated is true.
Example: "Sat, 01 Feb 2025 00:00:00 GMT"
The version used when no X-Truex-Version header is provided.
Example: "v2024_01_01"
Response
application/json
{ "supported_versions": [ { … } ], "default_version": "v2024_01_01", "version_header": "X-Truex-Version" }