Endpoint for private type
For the newly added
myOrderandmyAssettypes, requests must be made towss://EXCHANGE-REGION-ENDPOINT-URL.com/websocket/v1/private. Please refer to the "General Information" for more details.
Request
The requests is consisted of JSON Object and the response is also JSON Object. Requests are divided into ticket field, type field, and format field, and multiple type fields can be specified in one request. Please refer to Request method and format for ticket field and format field.
Request format
[{Ticket Field},{Type Field},....,{Type Field},{Format Field}]
Type Field
In this field, you have to list the market data you want to receive.
Field Name | Type | Description | Required | Default |
|---|---|---|---|---|
type | String | Data type
| O | |
codes | List | Market code list. Must be in capital letters. | X | If omitted or empty, data for all markets will be received. |
Response
For the
myOrdertype, data is transmitted only when specific events occur.It is normal if no data is received immediately after connection. Data will be sent for events such as order placement, execution, or cancellation. To maintain the connection, send ping/pong messages periodically.
| Field Name | Simplified Format | Description | Type | Value |
|---|---|---|---|---|
type | ty | Type | String | myOrder |
code | cd | Market code (e.g., SDG-BTC) | String | |
uuid | uid | Unique Order ID | String | |
ask_bid | ab | Ask/Bid | String | ASK, BID |
order_type | ot | Order method | String | limit, price, market, best |
state | s | Order state | String | wait, watch, trade, done, cancel |
trade_uuid | tuid | Unique transaction ID | String | |
price | p | Order or trade price | Double | |
avg_price | ap | Average trade price | Double | |
volume | v | Order or trade volume | Double | |
remaining_volume | rv | Remaining volume | Double | |
executed_volume | ev | Executed volume | Double | |
trades_count | tc | Number of trades in the order | Integer | |
reserved_fee | rsf | Reserved fee | Double | |
remaining_fee | rmf | Remaining fee | Double | |
paid_fee | pf | Paid fee | Double | |
locked | l | Locked funds | Double | |
executed_funds | ef | Executed funds | Double | |
time_in_force | tif | Time in force | String | ioc, fok |
trade_fee | tf | Trade fee (nullable) | Double | |
is_maker | im | Maker or taker (nullable) | Boolean | true, false |
identifier | id | Custom user value (only for orders after Oct 18, 2024) | String | |
trade_timestamp | ttms | Trade timestamp (ms) | Long | |
order_timestamp | otms | Order timestamp (ms) | Long | |
timestamp | tms | Event timestamp (ms) | Long | |
stream_type | st | Stream type | String | REALTIME |
Example
Request
Example 1: All market data (no codes)
[
{ "ticket": "test-myorder" },
{ "type": "myOrder" }
]Example 2: All market data (empty codes)
[
{ "ticket": "test-myorder" },
{ "type": "myOrder", "codes": [] }
]Example 3: Specific market data
[
{ "ticket": "test-myorder" },
{ "type": "myOrder", "codes": ["SGD-XRP"] }
]Response
{
"type": "myOrder",
"code": "SGD-XRP",
"uuid": "ac2dc2a3-fce9-40a2-a4f6-5987c25c438f",
"ask_bid": "BID",
"order_type": "limit",
"state": "trade",
"trade_uuid": "61314169-fba4-4375-ade3-aff14a656647",
"price": 0.001453,
"avg_price": 0.00145372,
"volume": 30925891.29839369,
"remaining_volume": 29968038.09235948,
"executed_volume": 30925891.29839369,
"trades_count": 1,
"reserved_fee": 44.23943970238218,
"remaining_fee": 21.77177967409916,
"paid_fee": 22.467660028283017,
"locked": 43565.33112787242,
"executed_funds": 44935.32005656603,
"time_in_force": null,
"trade_fee": 22.467660028283017,
"is_maker": true,
"identifier": "test-1",
"trade_timestamp": 1710751590123,
"order_timestamp": 1710751590000,
"timestamp": 1710751597500,
"stream_type": "REALTIME"
}