REST
/
Instruments
/
Get instruments

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

Get instruments

Request

Query for instruments available on the exchange by specific instrument ID or name. If no query parameters are supplied than ALL available instruments will be returned.

Query
idstring

ID of instrument to query for.

symbolstring

Symbol of the instrument to query for.

curl -i -X GET \
  'https://docs.truex.co/_mock/rest/v1/api/v1/instrument?id=string&symbol=string'

Responses

Successful operation.

Bodyapplication/jsonArray [
idstring

Exchange assigned ID of the instrument.

Example: "0987654321"
statusstring

Current instrument state.

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

Market Data

Operations

Clients

Operations

Orders

Operations

Balances

Operations

Transfers

Operations