HTTP Protocols

Technical overview of HTTP API requests and responses, including authentication headers, request format, and JSON response structure for market data access.

1.1 Request Protocol

All HTTP endpoints use the GET method. You must include your API Key in the request headers for authentication.

1.2 Response Format

All responses are returned in JSON format.

Example Response

{
    "ret": 200,
    "msg": "success",
    "traceId": "698f920a-c53b-401c-bfac-4ea46b9b8f12",
    "data": [
        
    ]
}

Response Fields

Field	Description
ret	Response code. 200 indicates a successful response. Other values correspond to specific error codes (see Error Codes section).
msg	A brief message describing the request status, e.g., "success".
traceId	A unique identifier automatically generated by the system for each request. Useful for debugging and tracing requests in logs.
data	The actual data payload returned by the API. The structure depends on the specific endpoint called.

2. WebSocket Protocol Overview

All WebSocket connections share the same base URL. Different data types (stocks, crypto, forex, etc.) are distinguished by subscription parameters rather than separate endpoints.

Please refer to the following sections for details:

• WebSocket Subscription Address Specification — defines how to construct subscription URLs and parameters.

• WebSocket Example Code — provides sample code for establishing and maintaining a live connection.