❗️

Deprecated (2024.04~)

The myOrder, which includesmyTradedata has been released. The myTrade will thus be deprecated, and removed from the Websocket. The specific removal date will be announced through an announcement, so please use myOrder.

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
typeStringdata type
myTrade: My transactions
O
codesListMarket code list
*Must be requested in capital letters.
XIf you omit it or request an empty array, you will receive data for all markets.

Response

Field Name
Simplified Format (format: SIMPLE)
Description
TypeValue
typetyTypeStringmyTrade
codecdMarket code (ex. SDG-BTC)String
ask_bidabOrder typeStringASK

BID
pricepTraded priceDouble
volumevTraded volumeDouble
order_uuidouidUnique ID of the orderString
order_typeotType of the orderString
trade_uuidtuidUnique ID of the transactionString
trade_timestampttmsTransaction timestamp (millisecond)Long
stream_typestStream StringREALTIME

Example

Request

ex 1. To get all market information (not specify codes field)

[
  {
    "ticket": "test"
  },
  {
    "type": "myTrade"
  }
]

ex 2. To get all market information (empty array in codes)

[
  {
    "ticket": "test"
  },
  {
    "type": "myTrade",
    "codes": []
  }
]

ex 3. To get specific market information

[
  {
    "ticket": "test"
  },
  {
    "type": "myTrade",
    "codes": ["SGD-XRP"]
  }
]

Response

{
  "type": "myTrade",
  "code": "SGD-XRP",
  "ask_bid": "BID",
  "price": 0.709,
  "volume": 1.41043723,
  "order_uuid": "abcd2289-1xy2-1234-a123-994aa21212a1",
  "order_type": "price",
  "trade_uuid": "dd01abcd-a123-1a8x-821a-a1gb82g12345",
  "trade_timestamp": 1695274799682,
  "stream_type": "REALTIME"
}