AnnouncementsGuidesAPI ReferenceSupport
API Reference

List Subscriptions

Request

The requests is consisted of JSON Object and the response is also JSON Object. Requests are divided into ticket field, method field, format field.

📘

Request format

[{Ticket Field},{Method Field},{Format Field}]

Ticket Field

Field Name
Type
Description
Required
Default
ticketStringA value that can identify requestO

Method Field

Field Name
Type
Description
Required
Default
methodStringMethod to request

- LIST_SUBSCRIPTIONS		O

Format Field

If specified as "Simple", the response field names will be simplified.

Field Name
Type
Description
Required
Default
formatStringFormat to receive

- DEFAULT: default format
- SIMPLE: simplified format		XDEFAULT

❗️

Notice - Format Field

Please request with the same Format Field as when receiving real-time data.

The Format Field specifies the overall format for the current connection. Therefore, if you receive WebSocket data in the SIMPLE format and then request LIST_SUBSCRIPTIONS in the DEFAULT format, the previously requested data will be sent down in the DEFAULT format.

Response

Field Name
Simplified Format (format: SIMPLE)
Description
TypeValue
methodmthdMethod requestedStringLIST_SUBSCRIPTIONS
resultrsltResultList of Objects
result.typerslt.tyData typeString
result.codesrslt.cdsMarket code listList of String
tickettcktTicket requestedString

Example

Request

ex 1. LIST_SUBSCRIPTIONS request

[
  {
    "method": "LIST_SUBSCRIPTIONS"
  },
  {
    "type": "unique uuid"
  }
]

Response

ex 1. public data

{
  "method": "LIST_SUBSCRIPTIONS",
  "result": [
    {
      "type": "ticker",
      "codes": ["BTC-ETH"]
    },
    {
      "type": "orderbook",
      "codes": ["BTC-ETH"]
    }
  ],
  "ticket": "unique uuid"
}

ex 2. private data

{
  "method": "LIST_SUBSCRIPTIONS",
  "result": [
    {
      "type": "myAsset"
    },
    {
      "type": "myOrder",
      "codes": ["BTC-ETH"]
    }
  ],
  "ticket": "unique uuid"
}