List Subscriptions

Revision History

Version	Date	Changes
v1.1.5	2024-07-31	Addition of `List Subscriptions`

Method

Unlike data subscription request messages that include the "type" field, the request message for retrieving the list of subscribed streams includes the "method" field and functions as an operation message. Similar to data subscription request messages, the request is sent as a JSON array containing the Ticket field, Format field, and the "method" field..

Precautions When Specifying the Format Field

When requesting the list of subscribed streams, please specify the Format field in the same format as used during the actual data subscription request. Requesting in a different format will change the format of the currently subscribed data streams as well, so caution is advised. For example, if you have been receiving real-time streams in SIMPLE format but request this operation in DEFAULT format, the subscribed real-time streams will also be received in DEFAULT format.

Rate Limits

The request to retrieve the list of subscribed streams is also subject to rate limiting.

Request Message Format

To query the list of currently subscribed streams, you must create a JSON Object with the structure below using the active WebSocket connection and include it in the Data Type Object of the request message. For full specifications including the Ticket and Format fields, please refer to the WebSocket Usage Guide.

Field Name	Type	Description	Required	Default
method	String	Request method `LIST_SUBSCRIPTIONS`	Required

Check the proper endpoint based on your region.

The base_url differs by country/region. Make sure to specify the correct region value for your environment.

Quotation
- Singapore (sg): wss://sg-api.upbit.com/websocket/v1
- Indonesia (id): wss://id-api.upbit.com/websocket/v1
- Thailand (th): wss://th-api.upbit.com/websocket/v1

Exchange
- Singapore (sg): wss://sg-api.upbit.com/websocket/v1/private
- Indonesia (id): wss://id-api.upbit.com/websocket/v1/private
- Thailand (th): wss://th-api.upbit.com/websocket/v1/private

Examples

[
  {
    "ticket": "0e66c0ac-7e13-43ef-91fb-2a87c2956c49"
  },
  {
    "method": "LIST_SUBSCRIPTIONS"
  }
]

Response Specification

Field Name	Abbreviation	Description	Type	Value
method	mthd	Request method	String	`LIST_SUBSCRIPTIONS`
result	rslt	Request result	List of Objects
result.type	rslt.ty	Data type	String
result.codes	rslt.cds	List of pair codes	List of String
result.level	rslt.lv	Orderbook aggregation unit	Double
ticket	tckt	Value that identifies the requester	Long

Examples

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

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